Added basic compilation instructions to README.md
[engrid-github.git] / build_instructions.txt
blob99b38cac89246f8f9c4c18afa9d22ba619e8eee3
2 Master branch
3 =============
5 Currently, only the master branch version of enGrid is guaranteed to compile. The previous versions (1.2 to 1.4) are not supported anymore, and probably won't compile on newer Linux releases as the build scripts have not been updated.
7 The current version of enGrid makes use of the CMake build system. Build instruction are simple:
9 - mkdir build
10 - cd build
11 - ccmake ../src
12 - press [c] to configure. If libraries are missing, cmake should issue a warning.
13 - if changes in the build type/configuration are needed, they can be done by modifing the available fields.
14   The install path can be modified by changing the CMAKE_INSTALL_PREFIX value.
15 - press [c] again to finalize the configuration.
16 - press [g] to generate the build information. If no errors are encountered, ccmake should exit.
17 - build with:
18   make -jN install, where N is the number of processor cores available.
20 enGrid should now be ready to run.