Skip to content
This repository was archived by the owner on Mar 4, 2026. It is now read-only.

Commit 74b27b6

Browse files
committed
README: document optional automatic download of Boost
1 parent 221fe27 commit 74b27b6

File tree

1 file changed

+15
-7
lines changed

1 file changed

+15
-7
lines changed

README.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -164,11 +164,6 @@ Make sure that you have the following dependencies:
164164

165165
* a C++17 capable compiler
166166

167-
* The following Boost libraries: Preprocessor, DynamicBitset, TypeTraits -
168-
version 1.65 or above is recommended
169-
170-
* For tests: Boost.Test version 1.65 or above
171-
172167
* cmake version 3.5 or above
173168

174169
Clone the repository:
@@ -194,8 +189,20 @@ cmake .. -DYOMM2_ENABLE_TESTS=1
194189
make && ctest
195190
```
196191

197-
If you also want to run the benchmarks (and in this case you really want a release
198-
build):
192+
YOMM2 uses several Boost libraries:
193+
194+
1. Preprocessor, DynamicBitset, TypeTraits: included by YOMM2 headers
195+
196+
2. Boost.Test: only used to run the test suite
197+
198+
If these libraries are already available on your machine, and they can by
199+
`cmake`, they will be used. In this case, make sure that the pre-installed
200+
libraries are at version 1.65 or above. If Boost is not found, the latest
201+
version will be downloaded, and the Boost headers mentioned in section (1) will
202+
be installed along YOMM2 (if you decide to `make install`).
203+
204+
If you also want to run the benchmarks (and in this case you really want a
205+
release build):
199206

200207
```
201208
cmake .. -DYOMM2_ENABLE_TESTS=1 -DYOMM2_ENABLE_BENCHMARKS=1 -DCMAKE_BUILD_TYPE=Release
@@ -215,6 +222,7 @@ make install DESTDIR=/path/to/my/libs
215222
```
216223
This will install the library and headers, as well as a CMake package
217224
configuration.
225+
218226
Make sure to add the install location to `CMAKE_PREFIX_PATH` so that you can use
219227
`find_package(YOMM2)` from your including project. For linking, the use
220228
`target_link_library(<your_target> YOMM2::yomm2)`. This will automatically add

0 commit comments

Comments
 (0)