From 7911cb10c542db91b459f71f5f3f36067b5ff80e Mon Sep 17 00:00:00 2001 From: mhoennig Date: Tue, 21 Jul 2026 13:19:56 +0200 Subject: [PATCH] docs: Englische README-Uebersetzung (README.en.md) Deutsch bleibt Quellsprache (CLAUDE: "Doku auf Deutsch"), daher die Uebersetzung als separate README.en.md statt README.md zu ersetzen. Wechselseitige Sprachlinks oben in beiden Dateien; Hinweis in der englischen Fassung, dass sie eine Convenience-Uebersetzung ist und der deutschen Vorlage hinterherhaengen kann. Co-Authored-By: Claude Opus 4.8 --- README.en.md | 69 ++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 2 ++ 2 files changed, 71 insertions(+) create mode 100644 README.en.md diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000..78ff219 --- /dev/null +++ b/README.en.md @@ -0,0 +1,69 @@ +

+ Werkbaum logo +

+ +# Werkbaum + +[Deutsch](README.md) · **English** + +A textual, Markdown-like notation for work breakdown structures with +and/or decomposition — plus a live editor that renders it as a diagram. + +``` +[~] Werkbaum (XL) https://wiki.example.de/relaunch + - [~] Document store + | [x] Text file with copy+paste in the frontend (S) + - [x] Parser + - [x] Text input field in the frontend + | [ ] Backend + - [~] Display/rendering (XL) + - [/] H (S) @anna + - [ ] CMS integration (M) + | [ ] WordPress + | [?] Headless CMS +``` + +`-` = mandatory sub-package (all of, side by side in the diagram) · +`|` = alternative (any of, stacked) · `[…]` = status · +`(M)` = T-shirt effort · `@name` = responsibility · `%%` = comment. + +## Usage + +Open `frontend/index.html` in the browser — edit text on the left, the +diagram is built live on the right. Toggles: transposed (narrow) layout, +show discarded elements. + +## Project documents + +- `frontend/` — editor · `backend/` — Kotlin/Spring (scaffold to follow, see backend/README.md) +- `docs/SPEC.md` — normative language definition +- `docs/DECISIONS.md` — design decisions with rationale +- `docs/ROADMAP.md` — Mermaid plugin, Taiga integration, Tenzu +- `docs/TASKS.md` — open tasks (checkboxes) +- `docs/brand/BRAND.md` — logo, wordmark, usage rules +- `docs/design/` — design derivation of the brand +- `CLAUDE.md` — project context for Claude Code + +> **Note:** The project documentation is maintained in German; German is the +> source language (see `CLAUDE.md`). This English README is a convenience +> translation and may lag behind the German original. + +## Deployment + +The editor is published as a static page on **GitHub Pages** via GitHub +Actions (workflow: `.github/workflows/pages.yml`). Triggered on every push to +`main` and manually (`workflow_dispatch`). + +The workflow assembles a site folder: `frontend/index.html` is placed as +`index.html` at the root URL, along with the files the editor references +(`docs/brand/` for the favicon, `LICENSE` for the MIT link in the footer). The +`../` paths in the editor source are straightened only on the copy — the source +file stays unchanged. `backend/` and the remaining `docs/` are not published. + +**One-time setup:** In the repo settings under **Pages**, select **Source** = +"GitHub Actions". The repo must be **public** for this (GitHub Pages via Actions +is only available for private repos on a paid plan). + +## License + +MIT — see [LICENSE](LICENSE). © 2026 Michael Hönnig. diff --git a/README.md b/README.md index a032693..32695f8 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,8 @@ # Werkbaum +**Deutsch** · [English](README.en.md) + Eine textuelle, Markdown-artige Notation für Projektstrukturpläne (Work Breakdown Structure) mit Und/Oder-Zerlegung — und ein Live-Editor, der sie als Diagramm rendert.