1<!-- Copyright 2018 Paul Fultz II
2     Distributed under the Boost Software License, Version 1.0.
3     (http://www.boost.org/LICENSE_1_0.txt)
4-->
5
6Building
7========
8
9Boost.HigherOrderFunctions library uses cmake to build. To configure with cmake create a build directory, and run cmake:
10
11    mkdir build
12    cd build
13    cmake ..
14
15Installing
16----------
17
18To install the library just run the `install` target:
19
20    cmake --build . --target install
21
22Tests
23-----
24
25The tests can be built and run by using the `check` target:
26
27    cmake --build . --target check
28
29The tests can also be ran using Boost.Build, just copy library to the boost source tree, and then:
30
31    cd test
32    b2
33
34Documentation
35-------------
36
37The documentation is built using Sphinx. First, install the requirements needed for the documentation using `pip`:
38
39    pip install -r doc/requirements.txt
40
41Then html documentation can be generated using `sphinx-build`:
42
43    sphinx-build -b html doc/ doc/html/
44
45The final docs will be in the `doc/html` folder.
46
47