aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/README.md
diff options
context:
space:
mode:
authorEgor Tensin <Egor.Tensin@gmail.com>2021-04-03 14:26:44 +0300
committerEgor Tensin <Egor.Tensin@gmail.com>2021-04-03 14:26:44 +0300
commit218e2e8b5b2bc69ac02f78aa2d0b2dccd947e779 (patch)
tree1eaad9c94433c3d1afca34ef2dc878dc64123ff4 /README.md
parentcmake: use install_pdbs() (diff)
downloadwinapi-debug-218e2e8b5b2bc69ac02f78aa2d0b2dccd947e779.tar.gz
winapi-debug-218e2e8b5b2bc69ac02f78aa2d0b2dccd947e779.zip
add `make install`, `make test`, etc.
Diffstat (limited to '')
-rw-r--r--README.md31
1 files changed, 11 insertions, 20 deletions
diff --git a/README.md b/README.md
index 92eef42..60991e9 100644
--- a/README.md
+++ b/README.md
@@ -14,26 +14,17 @@ vice versa, etc.
Building
--------
-Create the build files using CMake and build the project using Visual Studio.
-
-* **Prerequisites.**
-Depends on Boost.{Filesystem,Program_options}.
-* **Customization.**
-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.**
-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 --target install -- /m
- ...
+Build using CMake.
+Depends on Boost.{Filesystem,Program_options,Test}.
+The project is Windows-only, so building with either MSVC or MinGW-w64 is
+required.
+
+There's a Makefile with useful shortcuts to build the project in the .build/
+directory along with the dependencies (defaults to building with MinGW-w64):
+
+ make deps
+ make build
+ make test
License
-------