Skip to content

Commit

Permalink
docs(examples): update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Curve committed Mar 21, 2024
1 parent c493292 commit 81c371a
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,15 +107,18 @@ The examples can be built using CMake:
> __Important__: Make sure all dependencies are installed and have been built previously
```bash
mkdir build && cd build
cmake .. -DVIENNAPS_BUILD_EXAMPLES=ON
make buildExamples
git clone https://github.com/ViennaTools/ViennaPS.git
cd ViennaPS
cmake -B build -DVIENNAPS_BUILD_EXAMPLES=ON
cmake --build build
```

The examples can then be executed in their respective build folders with the config files, e.g.:
```bash
cd examples/exampleName
./ExampleName config.txt
./ExampleName.bat config.txt # (Windows)
./ExampleName config.txt # (Other)
```

Individual examples can also be build by calling `make` in their respective build folder. An equivalent Python script, using the ViennaPS Python bindings, is also given for each example.
Expand Down

0 comments on commit 81c371a

Please sign in to comment.