We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
1 parent 42b7e36 commit 18d8c16Copy full SHA for 18d8c16
ksf_dir_meta_yaml.adoc
@@ -0,0 +1,22 @@
1
+= YAML-based metadata for Kaitai Struct Formats directories
2
+
3
+[[rationale]]
4
+== Rationale
5
+It is needed to store some metadata for each directory in `kaitai_struc_formats` repo.
6
7
+[[format]]
8
+== Format
9
10
+* YAML is used as a serialization format.
11
12
+* The file path relative to the repo root is `_build/dirMeta.yml`
13
14
+* Each dir name is a key in a YAML dictionary.
15
16
+* Metadata is stored in mandatory `_` subkey.
17
18
+* There are 2 keys defined in `_`:
19
+** `short` for a mandatory summary.
20
+** `long` for more extended guidelines what goes into this dir and wat doesn't
21
22
+* A JSONSchema will be also available.
0 commit comments