From: Andrea Righi <andrea.righi@canonical.com>
Date: Mon, 14 Nov 2022 10:25:27 +0000 (+0100)
Subject: doc: add a basic README.md
X-Git-Tag: v0.1~72
X-Git-Url: https://jxself.org/git/?a=commitdiff_plain;h=9c3371475dcb17d92e20005a4eca9b49ad4a8dbe;p=annotations.git

doc: add a basic README.md

Signed-off-by: Andrea Righi <andrea.righi@canonical.com>
---

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3be11ba
--- /dev/null
+++ b/README.md
@@ -0,0 +1,44 @@
+What is annotations?
+====================
+
+annotations is a tool that allows to parse and manage kernel .config files
+in annotations format (Ubuntu kernel .config format).
+
+annotations allows to query individual .config options, architectures or
+flavours and it allows to import/export settings from annotations format to
+kconfig format and vice-versa.
+
+Examples
+========
+
+Show settings for `CONFIG_DEBUG_FS` for master kernel across all the supported
+architectures and flavours:
+```
+$ annotations -f debian.master/config/annotations --query --config CONFIG_DEBUG_FS
+{
+    "policy": {
+        "amd64": "y",
+        "arm64": "y",
+        "armhf": "y",
+        "ppc64el": "y",
+        "riscv64": "y",
+        "s390x": "y"
+    },
+    "note": "'required debug option'"
+}
+```
+
+Dump kernel .config for linux-aws, architecture arm64 and flavour generic-64k:
+```
+$ annotations -f debian.aws/config/annotations -a arm64 -l generic-64k --export
+CONFIG_DEBUG_FS=y
+CONFIG_DEBUG_KERNEL=y
+CONFIG_COMPAT=y
+...
+```
+
+Update annotations file with a new kernel .config for amd64 flavour generic
+(master kernel):
+```
+$ annotations -f debian.master/config/annotations --arch amd64 --flavour generic --import build/.config
+```