Skip to content

Commit

Permalink
Documented the proposed metadata format for the dirs in ksf.
Browse files Browse the repository at this point in the history
  • Loading branch information
KOLANICH committed Mar 6, 2021
1 parent 42b7e36 commit 18d8c16
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions ksf_dir_meta_yaml.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
= YAML-based metadata for Kaitai Struct Formats directories

[[rationale]]
== Rationale
It is needed to store some metadata for each directory in `kaitai_struc_formats` repo.

[[format]]
== Format

* YAML is used as a serialization format.

* The file path relative to the repo root is `_build/dirMeta.yml`

* Each dir name is a key in a YAML dictionary.

* Metadata is stored in mandatory `_` subkey.

* There are 2 keys defined in `_`:
** `short` for a mandatory summary.
** `long` for more extended guidelines what goes into this dir and wat doesn't

* A JSONSchema will be also available.

0 comments on commit 18d8c16

Please sign in to comment.