aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/README.md
diff options
context:
space:
mode:
authorEgor Tensin <Egor.Tensin@gmail.com>2021-09-26 19:16:16 +0300
committerEgor Tensin <Egor.Tensin@gmail.com>2021-09-26 19:16:16 +0300
commit0691ab3e886fcac63a6ed13a346ad16ae90ee5cb (patch)
tree169be0ecfe3108d74741a047773142490441ff13 /README.md
parentworkflows/ci: use default clang-format (diff)
downloadwinapi-common-0691ab3e886fcac63a6ed13a346ad16ae90ee5cb.tar.gz
winapi-common-0691ab3e886fcac63a6ed13a346ad16ae90ee5cb.zip
README: update
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/README.md b/README.md
index 4f11d67..abb9774 100644
--- a/README.md
+++ b/README.md
@@ -6,6 +6,21 @@ winapi-common
C++ wrappers for various common WinAPI entities I've had to use in various
projects over the years.
+Development
+-----------
+
+Build using CMake.
+Depends on Boost.Test and Python 3 for running the tests.
+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 (defaults to building with MinGW-w64):
+
+ make deps
+ make build
+ make test
+
License
-------