Installation

Installation on Windows

Installation using a setup program

• Download the setup executable and run it.
• The SoulNG is by default installed to the C:\soulng directory.
• The C:\soulng\bin directory is added to the system PATH environment variable.
• The setup creates a system environment variable SOULNG_ROOT that contains the path to the installation directory.
• The SOULNG_ROOT environment variable is needed at run-time to locate the Unicode character database soulng_ucd.bin in the unicode subdirectory.

Installation from sources

Requirements

• Requires Visual C++ version 19.29.30136 for x64 (or later). Executing command 'cl /?' from the x64 Native Tools Command Prompt for VS 2019 prints the Visual C++ version number.
• Requires Boost C++ libraries. The exact version does not matter as far as it is a reasonably recent version. The soulng binaries have been built using Boost version 1.77.

Download

• Download a Soulng 3.1.0 Source Package
• Extract it to a directory of your choice here called C:\soulng-3.1.0-src.

Configuration

• Open C:\soulng\config\build.props file with a text editor.
• Set the contents of the BOOST_INCLUDE_DIR element to the path to your Boost include directory. The default value is C:\boost\include\boost-1_77.
• Set the contents of the BOOST_LIB_DIR element to the path to your Boost library directory. The default value is C:\boost\lib.

Compilation

• Make an environment variable SOULNG_ROOT with value C:\soulng-3.1.0-src.
• Add the C:\soulng-3.1.0-src\bin directory to the PATH environment variable.
• Open x64 Native Tools Command Prompt for VS 2019
• Change to C:\soulng-3.1.0-src\nmake directory.
• Run nmake.

Installation on Linux / on WSL

Requirements

• Requires g++ version 10.3.0 or later (executing command 'g++ --version' prints the version number). Here's how to obtain it on Ubuntu Linux 20.04:
  • C++ 10 installation:

                   sudo apt install gcc-10 g++-10
  			

  • making C++ 10 the default:

                   sudo update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-10 100 --slave /usr/bin/g++ g++ /usr/bin/g++-10 --slave /usr/bin/gcov gcov /usr/bin/gcov-10
  			

• Requires Boost C++ libraries. The exact version does not matter as long as it is reasonable recent. The setup has been tested using Boost version 1.71.0.
  Here's how obtain the Boost version number on Ubuntu Linux:

              dpkg -s libboost-dev | grep 'Version'
              Version: 1.71.0.0ubuntu2
  		

  You can use your package manager to install Boost if you do not have it already.

Building and installing

• Download the SoulNG 3.1.0 Source Package.
• Extract it to a directory of your choice here called soulng-3.1.0-src:

                slaakko@pluto:~$ tar xjf soulng-3.1.0-src.tar.bz2
            

• change to the soulng-3.1.0-src directory:

                  slaakko@pluto:~$ cd soulng-3.1.0-src
              

• run make:

                  slaakko@pluto:~/soulng-3.1.0-src$ make
              

• Set an environment variable with name SOULNG_ROOT that points to the soung-3.1.0-src directory.

                  slaakko@pluto:~/soulng-3.1.0-src$ export SOULNG_ROOT=~/soulng-3.1.0-src
              

  You have to put it to your profile script to make it permanent. The SOULNG_ROOT environment variable is needed at run-time to locate the Unicode database that is in the soung-3.1.0-src/unicode subdirectory.
• run [sudo] make install

                  slaakko@pluto:~/soulng-3.1.0-src$ sudo make install
              

  The binaries are installed by default to the /usr/local/bin directory, libraries to the /usr/local/lib directory, and headers to the /usr/local/include/soulng, /usr/local/include/sngxml, /usr/local/include/sngcpp and /usr/local/include/sngcm directories. You can set the installation location by giving the prefix argument:
  [sudo] make prefix=/where/to/install install.