aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8209d24
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+# MSGPACK
+
+This is a simple implementation of the MessagePack specification (`spec.md` in the tree)
+This library uses on dynamic allocations
+
+### Usage
+
+See the api in `msgpack.h`, it is self-explanatory
+
+### Building
+
+This project use ninja and m4 macros, use `ninja` to build, with
+options like:
+`shared`, `static`, `header` for bulding to a usable library and
+`test`to run the unit tests.
+
+To change paths and presets using `ninja configure` with an
+appropriate environment variable:
+`BIN=<path>` to set the output directory
+`PROD=1` to use the non-debug flags