Skip to content

Commit 860cb5d

Browse files
authored
Update README.md
1 parent f1a061c commit 860cb5d

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,14 @@
33

44
## Build suggestion
55

6-
Create a build directory (we suggest ~/builds)
7-
Create a sub-dir of that directory per branch to build in (this maintains build isolation and avoids polluting your checked out repository)
8-
Execute `cmake -g "Unix Makefiles" ~/<path to test>` to generate makefiles.
9-
Use `make -j16` (for some parallelism in building) to build testing binaries.
6+
This library is header-only.
7+
There are comprehensive examples in the Catch2 based tests.
8+
9+
1. Do not forget to initialize at lest the Catch2 submodule (`git submodule update --init --recursive`)
10+
2. Create a build directory (we suggest ~/builds)
11+
3. Create a sub-dir of that directory per branch to build in (this maintains build isolation and avoids polluting your checked out repository)
12+
4. Execute `cmake -g "Unix Makefiles" ~/<path to repository root of your checkout>/test` to generate makefiles.
13+
5. Use `make -j16` (for some parallelism in building) to build testing binaries.
1014

1115
If you understand GitHub actions, see our "actions configuration" file, [`.github/workflows/master.yaml`](https://github.com/thecppzoo/zoo/blob/master/.github/workflows/master.yaml)
1216

0 commit comments

Comments
 (0)