Skip to content

Commit

Permalink
Fixed gitignore to not ignore the build instructions documentation file.
Browse files Browse the repository at this point in the history
  • Loading branch information
discopt committed Sep 2, 2024
1 parent 0e06f93 commit 0b80134
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 1 deletion.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
build*
/build*
*.kdev4
*.csv
*.ods
Expand Down
25 changes: 25 additions & 0 deletions doc/build.md
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.

0 comments on commit 0b80134

Please sign in to comment.