Skip to content

Commit 7515679

Browse files
authored
Update BUILDING.md
1 parent f82b45a commit 7515679

File tree

1 file changed

+13
-32
lines changed

1 file changed

+13
-32
lines changed

BUILDING.md

Lines changed: 13 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,28 @@
11
# Building with CMake
22

3-
## Build
4-
5-
This project doesn't require any special command-line flags to build to keep
6-
things simple.
7-
8-
Here are the steps for building in release mode with a single-configuration
9-
generator, like the Unix Makefiles one:
3+
Enabling developer mode will build the benchmarks, tests, and examples.
104

115
```sh
126
cmake -S . -B build -D CMAKE_BUILD_TYPE=Release -D BINARY_LOG_DEVELOPER_MODE=ON
137
cmake --build build
148
```
159

16-
Here are the steps for building in release mode with a multi-configuration
17-
generator, like the Visual Studio ones:
18-
19-
```sh
20-
cmake -S . -B build -D CMAKE_BUILD_TYPE=Release -D BINARY_LOG_DEVELOPER_MODE=ON
21-
cmake --build build --config Release
22-
```
23-
24-
## Install
25-
26-
This project doesn't require any special command-line flags to install to keep
27-
things simple. As a prerequisite, the project has to be built with the above
28-
commands already.
29-
30-
The below commands require at least CMake 3.15 to run, because that is the
31-
version in which [Install a Project][1] was added.
32-
33-
Here is the command for installing the release mode artifacts with a
34-
single-configuration generator, like the Unix Makefiles one:
10+
Here is the command for installing the release mode artifacts:
3511

3612
```sh
3713
cmake --install build
3814
```
3915

40-
Here is the command for installing the release mode artifacts with a
41-
multi-configuration generator, like the Visual Studio ones:
16+
# Running the Tests
4217

43-
```sh
44-
cmake --install build --config Release
45-
```
18+
Once built, you can run the tests like so:
4619

47-
[1]: https://cmake.org/cmake/help/latest/manual/cmake.1.html#install-a-project
20+
```console
21+
foo@bar:~/dev/binary_log$ ./build/test/binary_log_test
22+
[doctest] doctest version is "2.3.5"
23+
[doctest] run with "--help" for options
24+
===============================================================================
25+
[doctest] test cases: 10 | 10 passed | 0 failed | 0 skipped
26+
[doctest] assertions: 522 | 522 passed | 0 failed |
27+
[doctest] Status: SUCCESS!
28+
```

0 commit comments

Comments
 (0)