Skip to content

Commit 52e6545

Browse files
committed
Update README
1 parent 2a97178 commit 52e6545

File tree

1 file changed

+20
-13
lines changed

1 file changed

+20
-13
lines changed

README.md

Lines changed: 20 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -37,27 +37,36 @@ See [examples](./examples) for recipes inspirations and technical details.
3737

3838
## Installation
3939

40-
### Build and run the standalone target
40+
### Build and run a target
4141

42-
Use the following command to build and run the executable target.
42+
The project contains the following separate targets:
43+
44+
- test
45+
- examples (and all subfolders)
46+
- documentation
47+
- all
48+
49+
All of those can be built by the following process:
4350

4451
```bash
45-
cmake -S standalone -B build/standalone
46-
cmake --build build/standalone
47-
./build/standalone/KitGenBench --help
52+
cmake -S /path/to/<target> -B /path/to/build/<target> -Dalpaka_ACC_CPU_B_SEQ_T_SEQ_ENABLE:BOOL=ON
53+
cmake --build /path/to/build/<target> [--target GenerateDocs]
4854
```
4955

50-
### Build and run test suite
56+
wherein `[--target GenerateDocs]` is to be used only for building docs.
57+
This sets `Dalpaka_ACC_CPU_B_SEQ_T_SEQ_ENABLE` which allows running kernels sequentially on the host CPU.
58+
See [the alpaka docs](https://alpaka.readthedocs.io/en/stable/advanced/cmake.html) for details including other options.
59+
60+
### Running the tests
5161

5262
Use the following commands from the project's root directory to run the test suite.
5363

5464
```bash
55-
cmake -S test -B build/test
56-
cmake --build build/test
57-
CTEST_OUTPUT_ON_FAILURE=1 cmake --build build/test --target test
65+
# build tests as above
66+
CTEST_OUTPUT_ON_FAILURE=1 cmake --build /path/to/build/test --target test
5867

5968
# or simply call the executable:
60-
./build/test/KitGenBenchTests
69+
/path/to/build/test/KitGenBenchTests
6170
```
6271

6372
To collect code coverage information, run CMake with the `-DENABLE_TEST_COVERAGE=1` option.
@@ -87,10 +96,8 @@ cmake --build build
8796

8897
# run tests
8998
./build/test/KitGenBenchTests
90-
# format code
91-
cmake --build build --target fix-format
9299
# run standalone
93-
./build/standalone/KitGenBench --help
100+
./build/examples/*/KitGenBenchExample* --help
94101
# build docs
95102
cmake --build build --target GenerateDocs
96103
```

0 commit comments

Comments
 (0)