Installing SOD
Download the tar.gz or zip of SOD, and unpack it. This will result in a directory structure like the following:
-
sod-3.0.0beta8
- bin - scripts for running SOD on *nix
- bat - scripts for running SOD on windows
- build.gradle - script for recompiling SOD via gradle
- docs - documentation
- etc - helper files
- recipes - sample example recipes from the tutorial
- lib - SOD's libraries
- src - SOD's source code, if you are curious
Installing Java
SOD uses Java 1.5 or later. You can find out what version of Java you have on your system by running 'java -version' at the command line. If your version is less than 1.5 or is gcj, go to Java's website for a more recent version. Unfortunately, gjc, which comes with many Linux distributions, is not quite Java and prevents SOD from running. Please use Java from Sun on Linux instead.
Setting PATH
SOD is ready to run once it's unpacked and Java is installed; just invoke bin/sod or bat\sod.bat in the unpacked directory to run it. However, for easy invocation, people usually add SOD's bin directory to their path. This is somewhat system dependent on Unix like operating systems, but we have directions on how to do it under Windows below.
Windows
To add SOD's bat
directory to your system's path open Control Panel -> System -> Advanced -> Environment Variables
.
If an entry with name PATH
exists, append ;<the full path to your SOD directory>\bat
to its value.
Otherwise, create a new variable PATH
and set it to <the full path to your SOD directory>\bat
.