Updated README.md with the new BUILD_SAMPLES option

This commit is contained in:
jpekkila
2020-01-15 17:02:47 +02:00
parent 7a099a008e
commit 8f646e700e
2 changed files with 4 additions and 4 deletions

View File

@@ -25,7 +25,7 @@ option(BUILD_DEBUG "Builds the program with extensive error checkin
option(BUILD_STANDALONE "Builds the standalone Astaroth" ON) option(BUILD_STANDALONE "Builds the standalone Astaroth" ON)
option(BUILD_UTILS "Builds the utility library" ON) option(BUILD_UTILS "Builds the utility library" ON)
option(BUILD_RT_VISUALIZATION "Builds the module for real-time visualization using SDL2" OFF) option(BUILD_RT_VISUALIZATION "Builds the module for real-time visualization using SDL2" OFF)
option(BUILD_SAMPLES "Builds samples" OFF) option(BUILD_SAMPLES "Builds projects in samples subdirectory" OFF)
option(DOUBLE_PRECISION "Generates double precision code" OFF) option(DOUBLE_PRECISION "Generates double precision code" OFF)
option(MULTIGPU_ENABLED "If enabled, uses all the available GPUs" ON) option(MULTIGPU_ENABLED "If enabled, uses all the available GPUs" ON)
option(MPI_ENABLED "Enables additional functions for MPI communciation" OFF) option(MPI_ENABLED "Enables additional functions for MPI communciation" OFF)

View File

@@ -46,7 +46,8 @@ See [CMakeLists.txt](https://bitbucket.org/jpekkila/astaroth/src/master/CMakeLis
| BUILD_STANDALONE | Builds a standalone library for testing, benchmarking and simulation | ON | | BUILD_STANDALONE | Builds a standalone library for testing, benchmarking and simulation | ON |
| BUILD_UTILS | Builds a generic utility library (WIP replacement for BUILD_STANDALONE) | ON | | BUILD_UTILS | Builds a generic utility library (WIP replacement for BUILD_STANDALONE) | ON |
| BUILD_RT_VISUALIZATION | Builds the real-time visualization module | OFF | | BUILD_RT_VISUALIZATION | Builds the real-time visualization module | OFF |
| BUILD_DOUBLE_PRECISION | Generates double precision code | OFF | | BUILD_SAMPLES | Builds projects in samples subdirectory | OFF |
| DOUBLE_PRECISION | Generates double precision code | OFF |
| MULTIGPU_ENABLED | Enables Astaroth to use multiple GPUs on a single node | ON | | MULTIGPU_ENABLED | Enables Astaroth to use multiple GPUs on a single node | ON |
| MPI_ENABLED | Enables additional functions for MPI communciation | OFF | | MPI_ENABLED | Enables additional functions for MPI communciation | OFF |
| DSL_MODULE_DIR | Defines the directory to be scanned when looking for DSL files | `astaroth/acc/mhd_solver` | | DSL_MODULE_DIR | Defines the directory to be scanned when looking for DSL files | `astaroth/acc/mhd_solver` |
@@ -87,4 +88,3 @@ How do I compile with MPI support?
How do I contribute? How do I contribute?
> See [Contributing](CONTRIBUTING.md). > See [Contributing](CONTRIBUTING.md).