From 1a44c30c94dbbf0f3aabc1610d61b032d9d80e29 Mon Sep 17 00:00:00 2001 From: xengineering Date: Thu, 24 Jul 2025 14:37:21 +0200 Subject: doc: api: Add README.md and flatten future.md structure This makes it later possible to diff the planned `current.md` with the `future.md`. When the firmware is feature-complete the diff should be empty. --- doc/api/README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 doc/api/README.md (limited to 'doc/api/README.md') diff --git a/doc/api/README.md b/doc/api/README.md new file mode 100644 index 0000000..918ec19 --- /dev/null +++ b/doc/api/README.md @@ -0,0 +1,13 @@ +# API specification + +This folder contains the API specification as required by semantic versioning. + +Currently only the `future.md` file is given. This is the long term goal how +the API should look like at the time of writing / committing. + +This will be extended by a `current.md` file describing the current state using +the same structure. This version has to match always with the implementation in +every commit. + +By this approach it will be possible to see what is left to implement by +running `diff current.md future.md`. -- cgit v1.2.3-70-g09d2