aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/README.md
diff options
context:
space:
mode:
authorEgor Tensin <Egor.Tensin@gmail.com>2019-12-22 10:33:53 +0300
committerEgor Tensin <Egor.Tensin@gmail.com>2019-12-22 10:33:53 +0300
commitd835fc054afcd5af04b6047e06651e9a62e304f8 (patch)
treed1630454a9a2f2780e005ef8672d47734c11e9d2 /README.md
parentcmake: install() PDBs & use Boost::* (diff)
downloadwinapi-debug-d835fc054afcd5af04b6047e06651e9a62e304f8.tar.gz
winapi-debug-d835fc054afcd5af04b6047e06651e9a62e304f8.zip
README: update
Diffstat (limited to 'README.md')
-rw-r--r--README.md27
1 files changed, 11 insertions, 16 deletions
diff --git a/README.md b/README.md
index ccc8de9..45f528f 100644
--- a/README.md
+++ b/README.md
@@ -17,27 +17,22 @@ Building
Create the build files using CMake and build the project using Visual Studio.
* **Prerequisites.**
-The following Boost libraries are required to build the project: Filesystem,
-Program_options, System.
+Depends on Boost.{Filesystem,Program_options}.
* **Customization.**
-The runtime libraries are linked statically by default (when this project is
-the root CMake project).
-Therefore, the Boost dependencies must also link them statically.
-You can link the runtime dynamically by passing `-D USE_STATIC_RUNTIME=OFF` to
+The runtime libraries are linked statically by default.
+Therefore, the Boost libraries must also link them statically.
+You can link the runtime dynamically by passing `-D CC_STATIC_RUNTIME=OFF` to
`cmake`.
* **Example.**
-In the example below, the project directory is
-"C:\workspace\personal\pdb-repo", Boost can be found in
-"C:\workspace\third-party\boost_1_61_0" and Visual Studio 2015 is used,
-targeting x86-64.
-
- > cmake -G "Visual Studio 14 2015 Win64" ^
- -D BOOST_ROOT=C:\workspace\third-party\boost_1_61_0 ^
- -D Boost_USE_STATIC_RUNTIME=ON ^
- C:\workspace\personal\pdb-repo
+Using Visual Studio 2015 (targeting x64), build & install the release version
+to C:\pdb-repo:
+
+ > cmake -G "Visual Studio 14 2015" -A x64 ^
+ -D BOOST_ROOT=C:\path\to\boost_1_61_0 ^
+ C:\path\to\pdb-repo
...
- > cmake --build . --config release -- /m
+ > cmake --build . --config Release --target install -- /m
...
License