-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fixed gitignore to not ignore the build instructions documentation file.
- Loading branch information
Showing
2 changed files
with
26 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
build* | ||
/build* | ||
*.kdev4 | ||
*.csv | ||
*.ods | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# Build instructions {#build} | ||
|
||
The library can be built using the [CMake build system](https://cmake.org/). | ||
A simple command sequence on Linux looks like this: | ||
|
||
mkdir build | ||
cd build | ||
cmake .. | ||
make | ||
|
||
Below you can find a list of all parameters for building CMR. | ||
As an optional step, one can execute unittests: | ||
|
||
make test | ||
|
||
The executables now reside in the current directory. One can also install them via | ||
|
||
make install | ||
|
||
**Build Parameters** | ||
|
||
- `-DCMAKE_BUILD_TYPE=Release` Compiles the code with optimization turned on. Make sue to use this if you need fast code for large matrices. | ||
- `-DGENERATORS=on` Builds [generator tools](\ref generators) for certain matrices. | ||
- `-DGMP=off` Disables large numbers; see \ref equimodular. | ||
|