Merge pull request 'Add README' (#1 ) from readme into main

Reviewed-on: #1
Merge branch 'main' into readme
2023-09-27 13:01:38 +00:00 · 2023-09-27 13:01:34 +00:00 · 2023-09-14 09:19:40 +00:00 · 2023-09-13 19:06:49 +00:00 · 2023-09-13 19:05:54 +00:00 · 2023-09-13 19:05:27 +00:00
1 changed files with 16 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,16 @@
+# Kwil Header tool
+
+An in-development command line tool for generating serialization code from C header files.
+
+Kwil aims to be a non-intrusive drop-in (and if necessary drop-out) solution to automate the annoying task of writing deserialization and serialization code.
+
+Currently aiming for json support, though adding (optional) support for other formats is strongly considered for implementing at a later time.
+
+
+Features:
+
+[x] Generate `*_json_length` and `*_to_json`functions for structs and enums marked with `KWIL_STRUCT()` or `KWIL_ENUM()`
+
+[ ] Generate `*_from_json` functions for structs.
+
+[ ] Dynamic array length specifiers (e.g: `KWIL_FIELD(LEN=13` or `KWIL_FIELD(LEN=src->field_length`)
Author	SHA1	Message	Date
Sara	1e10d9f7d2	Merge pull request 'Add README' (#1 ) from readme into main Reviewed-on: #1	2023-09-27 13:01:38 +00:00
Sara	16dfcfd41e	Merge branch 'main' into readme	2023-09-27 13:01:34 +00:00
Sara	72e83e4f38	Update 'README.md'	2023-09-14 09:19:40 +00:00
Sara	833e7bd2b0	Update 'README.md'	2023-09-13 19:06:49 +00:00
Sara	9546b128cb	Update 'README.md'	2023-09-13 19:05:54 +00:00
Sara	dda4f9b7d9	Update 'README.md'	2023-09-13 19:05:27 +00:00
Sara	d2c96f2f74	Update 'README.md'	2023-09-13 19:05:10 +00:00
Sara	0f0afb72a1	Added README	2023-09-13 15:08:26 +00:00