Skip to content

Commit e75ac43

Browse files
committed
Improve build documentation.
1 parent ff9434b commit e75ac43

File tree

2 files changed

+9
-4
lines changed

2 files changed

+9
-4
lines changed

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,12 @@ to parse the command line arguments and
4747
the events loop and manage network connection(s)).
4848

4949
# How to Build
50-
Detailed instructions on how to build and install all the components can be
50+
This project has several external dependencies. It is highly recommended to use
51+
[cc.cmake](https://github.com/commschamp/cc.cmake) project to bring in all the
52+
necessary components of the [CommsChampion Ecosystem](https://commschamp.github.io)
53+
(including this one as well) into a third party project.
54+
55+
Detailed instructions on how to build sources of **this** particular repository can be
5156
found in [doc/BUILD.md](doc/BUILD.md) file.
5257

5358
# How to Fuzz Test

doc/BUILD.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@ in configuration of the [github actions](../.github/workflows/actions_build.yml)
2222
The provided **applications** use [Boost](https://www.boost.org) libraries to
2323
parse their command line arguments as well as manage their event loop / network
2424
connections. In case the application are compiled and the [Boost](https://www.boost.org) libraries
25-
do not reside in a default system location, use [BOOST_ROOT](https://cmake.org/cmake/help/latest/module/FindBoost.html#hints)
26-
variable to specify their install directory. It is recommended to also use `-DBoost_USE_STATIC_LIBS=ON` parameter to force
27-
linkage with static Boost libraries (especially on Windows).
25+
do not reside in a default system location, use the relevant variables described in the
26+
[FindBoost](https://cmake.org/cmake/help/latest/module/FindBoost.html)
27+
documentation to help with finding appropriate boost libraries.
2828

2929
## Choosing C++ Standard
3030
The default and minimal required C++ standard version to build this project is **17**. However it

0 commit comments

Comments
 (0)