Skip to content

Commit b029515

Browse files
committed
add compilation hints in the README
1 parent 6775ea8 commit b029515

1 file changed

Lines changed: 8 additions & 0 deletions

File tree

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,14 @@
33
This software package calculates the Phantom modulus for the following systems:
44
- linear chains mixed with cross linkers
55

6+
## Compilation
7+
This project needs the [LeMonADE-library](https://github.com/LeMonADE-project/LeMonADE/) installed. The configure file helps to set the correct path and options. Execute in a shell
8+
```shell
9+
./configure -DLEMONADE_DIR=/path/to/installation/lemonade_install -DBUILDDIR=./build -DLEMONADE_TESTS=OFF/ON -DCMAKE_BUILD_TYPE=Release/Debug
10+
```
11+
This will run `cmake` and create the `build` directory. Now type in `make` which compiles the executables and runs the test if this option was given.
12+
13+
614
## Linear chains with cross linkers
715
The main [program](https://github.com/LeMonADE-project/LeMonADE_PhantomModulus/blob/master/projects/ForceEquilibrium.cpp) reads in a .bfm file and a data file. It is expected that the bfm file contains the following flags
816
```

0 commit comments

Comments
 (0)