Added README

readme
Sara 2023-09-13 15:08:26 +00:00
parent 1caccffa5b
commit 0f0afb72a1
1 changed files with 13 additions and 0 deletions

13
README.md Normal file
View File

@ -0,0 +1,13 @@
# Kwil Header tool
An in-development command line tool for generating serialization code from C header files.
Features:
[x] Generate `*_json_length` and `*_to_json`functions for structs and enums marked with `KWIL_STRUCT()` or `KWIL_ENUM()`
[ ] Generate `*_from_json` functins for structs.
[ ] Dynamic array length specifiers (e.g: `KWIL_FIELD(LEN=13` or `KWIL_FIELD(LEN=<field_name>`)
## Example
```c
#include "kwil.h" // kwil.h header contains empty KWIL_STRUCT() KWIL_ENUM() and KWIL_FIELD() macros
```