Commit 1f2d5286 authored by CARDOSI Paul's avatar CARDOSI Paul

Update README to include installation section.

parent 90cebb2a
......@@ -12,6 +12,20 @@ Replica Exchange Monte Carlo (RMC/Parallel tempering).
This is an on-going project under development.
# Installation
SPETABARU requires an out of source tree build.
1. First create a new directory outside of SPETABARU's source tree with mkdir <dir_name>
2. cd into the newly created directory.
3. Create a subdirectory with a name of your choice
4. Run cmake -DCMAKE_INSTALL_PREFIX=<path_to_directory_created_in_step_3> ..
5. Run make or make -j <number_of_commands_to_run_simultaneously>
6. Run make install
If you want to install the static SPETABARU library and its header files to your default user
library location you can remove the DCMAKE_INSTALL_PREFIX variable setting flag in step 4.
If you still prefer to create the build directory inside SPETABARU's source tree, we recommend
to call it "build" as this name has been explicitly marked as to be ignored by Git.
# Examples
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment