Update 'README.md'

readme
Sara 2023-09-13 19:05:10 +00:00
parent 0f0afb72a1
commit d2c96f2f74
1 changed files with 1 additions and 6 deletions

View File

@ -1,13 +1,8 @@
# Kwil Header tool # Kwil Header tool
An in-development command line tool for generating serialization code from C header files. An in-development command line tool for generating serialization code from C header files.
Features: Features:
[x] Generate `*_json_length` and `*_to_json`functions for structs and enums marked with `KWIL_STRUCT()` or `KWIL_ENUM()` [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. [ ] Generate `*_from_json` functins for structs.
[ ] Dynamic array length specifiers (e.g: `KWIL_FIELD(LEN=13` or `KWIL_FIELD(LEN=<field_name>`) [ ] 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
```