From 419fc315b4eb736bf267cef5a67f0c2b28e4bd16 Mon Sep 17 00:00:00 2001 From: kartofen Date: Wed, 2 Apr 2025 01:18:14 +0300 Subject: edit README --- README.md | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 8209d24..74c9523 100644 --- a/README.md +++ b/README.md @@ -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=` to set the output directory -`PROD=1` to use the non-debug flags +- `BIN=` to set the output directory +- `PROD=1` to use the non-debug flags -- cgit v1.2.3