first commit

README.md

@@ -0,0 +1,47 @@
+# CCMA - Chaotic Creature Member Administration
+
+File-based member administration for Chaos Computer Club Mannheim e.V.
+
+The member store remains readable without this application. Every member has a
+directory containing `member.json`, `contributions.json`, an append-only
+`events.jsonl`, and a `files/` directory.
+
+## Development
+
+Requires Python 3.11+ with Tk support.
+
+```bash
+python -m venv .venv
+.venv/bin/pip install -r requirements.txt
+.venv/bin/ccma
+```
+
+For development tools and tests, install the `dev` extra as well:
+
+```bash
+.venv/bin/pip install -e '.[dev]'
+```
+
+Alternatively, without installation:
+
+```bash
+PYTHONPATH=src python -m ccma
+```
+
+On first start, select or create the central member-store directory. The
+`VERSION` file is the single source for application and package versions.
+
+## Store layout
+
+```text
+member-store/
+├── repository.json
+└── members/
+    └── <uuid>/
+        ├── member.json
+        ├── contributions.json
+        ├── events.jsonl
+        └── files/
+```
+
+Do not place a real member store inside the source repository.