Document requirement of building Boost libraries

This should also clarify the CMake configuration provided
does not build any of Beast's dependencies within Boost.
Capitalize Boost name.
Closes #1064
This commit is contained in:
Mateusz Loskot
2018-03-11 21:17:27 +01:00
committed by Vinnie Falco
parent dabc1c8ae6
commit 06ee7c7ac6

View File

@@ -111,14 +111,16 @@ with the Boost.Coroutine library. Please visit the Boost documentation
for instructions on how to do this for your particular build system. for instructions on how to do this for your particular build system.
To build the documentation, examples, tests, and benchmarks it is To build the documentation, examples, tests, and benchmarks it is
necessary to first obtain the boost "superproject" along with all necessary to first obtain the Boost "superproject" along with sources of
of the boost libraries. Instructions for doing so may be found on all of the Boost libraries, then run the `b2` command to build the Boost
libraries.
Instructions for doing so may be found on
the [Boost Wiki](https://github.com/boostorg/boost/wiki/Getting-Started). the [Boost Wiki](https://github.com/boostorg/boost/wiki/Getting-Started).
These commamnds will build the programs and documentation that come These commamnds will build the programs and documentation that come
with Beast (omit the cxxflags parameter when building using MSVC): with Beast (omit the cxxflags parameter when building using MSVC):
``` ```
cd boost # The directory containing the boost superproject and libraries cd boost # The directory containing the Boost superproject and libraries
b2 libs/beast/test cxxflags="-std=c++11" # bjam must be in your $PATH b2 libs/beast/test cxxflags="-std=c++11" # bjam must be in your $PATH
b2 libs/beast/example cxxflags="-std=c++11" b2 libs/beast/example cxxflags="-std=c++11"
b2 libs/beast/doc b2 libs/beast/doc
@@ -128,7 +130,7 @@ On Windows platforms only, CMake may be used to generate a Visual Studio
solution and a set of Visual Studio project files using these commands: solution and a set of Visual Studio project files using these commands:
``` ```
cd boost # The directory containing the boost superproject and libraries cd boost # The directory containing the Boost superproject and libraries
cd libs/beast cd libs/beast
mkdir bin mkdir bin
cd bin cd bin