From 04bf98298fb76e7620442b7ea92c4cc51a322ec2 Mon Sep 17 00:00:00 2001 From: Vinnie Falco Date: Mon, 25 Sep 2017 20:43:37 -0700 Subject: [PATCH] Update build instructions fix #796 --- CHANGELOG.md | 1 + README.md | 31 ++++++++++++++++++++----------- 2 files changed, 21 insertions(+), 11 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 7cb4c483..3eefbeb4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,7 @@ Version 118: * file_win32 opens for read-only in shared mode * Remove unused strands in server examples +* Update build instructions HTTP: diff --git a/README.md b/README.md index 20de328d..ff7bf270 100644 --- a/README.md +++ b/README.md @@ -88,22 +88,31 @@ library to link with. If you use coroutines you'll also need to link with the Boost.Coroutine library. Please visit the Boost documentation for instructions on how to do this for your particular build system. -For the examples and tests, Beast provides build scripts for Boost.Build -(bjam) and CMake (Windows). It is possible to generate Microsoft Visual -Studio project files using CMake by executing these commands from -the root of the repository: +To build the documentation, examples, tests, and benchmarks it is +necessary to first obtain the boost "superproject" along with all +of the boost libraries. Instructions for doing so may be found on +the [Boost Wiki](https://github.com/boostorg/boost/wiki/Getting-Started). +These commamnds will build the programs and documentation that come +with Beast (omit the cxxflags parameter when building using MSVC): ``` +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/example cxxflags="-std=c++11" +b2 libs/beast/doc +``` + +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: + +``` +cd boost # The directory containing the boost superproject and libraries +cd libs/beast mkdir bin cd bin -cmake .. # for 32-bit Windows builds - -cd .. -mkdir bin64 -cd bin64 -cmake -G"Visual Studio 14 2015 Win64" .. # for 64-bit Windows builds (VS2015) +cmake .. # for 32-bit Windows builds, or +cmake -G"Visual Studio 14 2015 Win64" .. # for 64-bit Windows builds (VS2015), or cmake -G"Visual Studio 15 2017 Win64" .. # for 64-bit Windows builds (VS2017) - ``` The files in the repository are laid out thusly: