aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to '')
-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
-------