aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/README.md
diff options
context:
space:
mode:
authorEgor Tensin <Egor.Tensin@gmail.com>2021-03-31 20:10:48 +0300
committerEgor Tensin <Egor.Tensin@gmail.com>2021-03-31 20:10:48 +0300
commit4d20bc9c99ba1b25b171e6c9f9bb831e23d0ff14 (patch)
treedccaefedbbcc7985bc000f44ae760191b6422b83 /README.md
parentcmake: use install_pdbs() (diff)
downloadwinapi-utf8-4d20bc9c99ba1b25b171e6c9f9bb831e23d0ff14.tar.gz
winapi-utf8-4d20bc9c99ba1b25b171e6c9f9bb831e23d0ff14.zip
add `make build`, `make test`, etc.
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 6897188..42cc23f 100644
--- a/README.md
+++ b/README.md
@@ -5,6 +5,21 @@ winapi-utf8
UTF-8 <-> UTF-16 conversion functions, mainly to be used with WinAPI.
+Development
+-----------
+
+Build using CMake.
+Depends on Boost.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 (defaults to building with MinGW-w64):
+
+ make deps
+ make build
+ make test
+
License
-------