diff options
| author | kartofen <mladenovnasko0@gmail.com> | 2025-04-02 01:18:14 +0300 |
|---|---|---|
| committer | kartofen <mladenovnasko0@gmail.com> | 2025-04-02 01:18:14 +0300 |
| commit | 419fc315b4eb736bf267cef5a67f0c2b28e4bd16 (patch) | |
| tree | 80da9e61c098d7eb548b203adec950dc52d038dd | |
| parent | 40618c2ff1c18815741888674cc76c8ddc486300 (diff) | |
edit README
| -rw-r--r-- | README.md | 23 |
1 files changed, 12 insertions, 11 deletions
@@ -1,20 +1,21 @@ -# MSGPACK +# msgpack -This is a simple implementation of the MessagePack specification (`spec.md` in the tree) -This library uses on dynamic allocations +This is a simple implementation of the MessagePack specification (`spec.md` in the tree). -### Usage +This library uses NO dynamic allocations. -See the api in `msgpack.h`, it is self-explanatory +### 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. +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. 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 +- `BIN=<path>` to set the output directory +- `PROD=1` to use the non-debug flags |