From 495d908ef4337a7150a696c1708bc21b5c77f6bc Mon Sep 17 00:00:00 2001
From: Renat Nurgaliyev <renat@rnu.one>
Date: Wed, 20 May 2026 18:20:29 +0200
Subject: [PATCH] Add readme

---
 README.md | 36 ++++++++++++++++++++++++++++++++++++
 1 file changed, 36 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e981d13
--- /dev/null
+++ b/README.md
@@ -0,0 +1,36 @@
+# Amateurfunk
+
+Download the German amateur-radio exam question catalog from the
+Bundesnetzagentur and turn it into Anki decks.
+
+## Quick start
+
+```sh
+make           # fetch + build (default)
+make fetch     # download + extract the catalog only → data/
+make anki      # rebuild .apkg files from data/ → anki/
+make test      # run both test suites
+make clean     # remove data/ and anki/
+```
+
+Output: three `.apkg` files under `anki/`, one per Prüfungsteil
+(Technische / Betriebliche / Vorschriften). Import them into Anki —
+re-importing a newer build preserves your review history.
+
+## Requirements
+
+Python 3.11+, standard library only. No third-party dependencies.
+
+## More
+
+- `CLAUDE.md` — project orientation, pipeline overview.
+- `DESIGN.md` — source-discovery notes, JSON schema, per-stage
+  design contracts.
+
+## License
+
+The downloader and builder code is in this repo. The exam questions
+themselves are published by the Bundesnetzagentur under
+[DL-DE→BY-2.0](https://www.govdata.de/dl-de/by-2-0); attribution
+is preserved in every generated artifact (`README.txt` inside
+`data/<edition>/`, `attribution` field in the per-edition manifest).