aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: dc59126da177598130a4524dbf545684bc577400 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
# msgpack

This is a simple implementation of the MessagePack specification (`spec.md` in the tree).

This library uses NO dynamic allocations.

### Usage

See the api in `msgpack.h`, it is self-explanatory.
 
### Building

This project use ninja and m4 macros (so both need to be installed), 
use `ninja` to build, with options like:

* `shared`, `static`, `header` for bulding to a usable library and
* `test`to run the unit tests.
* `install` to install the built files in output directories set by `ninja configure`

To change paths and presets using `ninja configure` with an
appropriate environment variable:

* `PROD=1` to use the non-debug flags
* `PREFIX=<path>` used for other paths, default `installdir`
* `LIBDIR=<path>` used for libraries (.so and .a), default `PREFIX/lib`
* `INCLUDEDIR=<path>` used for c headers, default `PREFIX/include`