Simulation @ Edinburgh University, 2014

We are generally following the kernel style guide, with the exception of indenting by 4, not 8, spaces.

We are using CMake to govern the build process, the only supported platform is Linux/gcc. Others can be added in CMakeLists.txt

In order to build the code, you need to create a build directory, generate the makefile and build:

mkdir build
cd build
cmake ..
make -j3

which should produce a 'MCSimulation' executable for you.

To do that you need to be inside the build directory and make doc:

cd build
make doc

Using Doxygen. So write the documentation using markdown, which will enable easy HTML code generation. You can also find it helpful to look at the Doxygen specific markdown docs.