Chapter 2. Getting Started

As of now, there are no binary distributions of srctools. Therefore, you will be required to build it from scratch - the only way to run software. Before you begin, you will need the following tools and libraries.

CMake - Configures the build system.
GNU Make - Builds the software.
GNU g++ - Compiles the source code.
Boost C++ Libraries - The srctools distribution depends heavily upon Boost. Note that some binary distributions provide separate libraries for the Boost.Program_Options, Boost.Signal, and Boost.Filesystem libraries, upon which srctools depends (in addition to headers).
LibXML2 - Used to handle XML documents.
Sqlite3 - Used by some programs to maintain program analysis data.
srcML - Most of the srctools applications require source files specially formatted in srcML.

2.1. Building and Installing srctools

Building the distribution is fairly simple:


$ cd $SRCTOOLS_ROOT/build
$ cmake ..
$ make

The executables and libraries are found in directories with their respective names. For exammple, the srcnr binary is found in `$SRCTOOLS_ROOT/build/tools/srcnr`.

There is currently no installation feature for srctools. My suggestion is to copy or link the binaries produced by the distribution to a directory in your shell's search path. I recommend ~/bin.