Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Benedikt Moritz Maurer committed Oct 5, 2024
1 parent 8c2aaea commit cfc4fe5
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
This is flash, a super fast BSE solver.

# Install:
## Use `make`:
To build **Flash** with debug flags, release flags and the documentation type in the root directory
```bash
make
Expand All @@ -13,6 +14,16 @@ make documentation
```
If you wish to make build the documentation, make sure that doxygen is installed.

## The classic way
You can avoid using the `Makefile` and build the code with cmake
```bash
mkdir build
cd build
cmake ../dev/
cmake --build
```
The make commands are doing exactly that.

## Run unit tests:
Run all tests:
```
Expand Down

0 comments on commit cfc4fe5

Please sign in to comment.