From fe450cd39ee6ca1c63a147b46cbda09688e57fcc Mon Sep 17 00:00:00 2001 From: Eduard Iten Date: Sun, 4 Jan 2026 13:11:00 +0100 Subject: [PATCH] =?UTF-8?q?Lizenz=20hinzugef=C3=BCgt?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 23 +++++++++++++++++++++++ doc/docs/index.md | 5 +++++ doc/docs/license.md | 9 +++++++++ doc/mkdocs.yml | 1 + 4 files changed, 38 insertions(+) create mode 100644 doc/docs/license.md diff --git a/README.md b/README.md index e69de29..584b881 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,23 @@ +# Lasertag (nRF + Thread) + +DIY-Lasertag-System auf Basis von nRF52840, Thread und BLE. Enthält Firmware (Zephyr), Hardware-Designs und die begleitende Dokumentation. + +## Dokumentation +- Live: https://home.iten.pro/lasertag +- Quellen: doc/ (MkDocs mit Material-Theme) +- Schnelleinstieg: Konzept, Gameplay, Planung unter doc/docs/ + +## Repo-Überblick +- firmware/ – Zephyr-Anwendungen (Leader, Weapon) und gemeinsame Libraries +- hardware/ – KiCad-Designs und Skizzen +- doc/ – MkDocs-Projekt für die Doku (build/serve über mkdocs) +- software/ – Provisioning-Frontend und Tools + +## Lokale Doku bauen +```bash +cd doc +mkdocs serve # oder: mkdocs build +``` + +## Lizenz +CC BY-NC-SA 4.0 – siehe [LICENSE](LICENSE) für den vollständigen Text. diff --git a/doc/docs/index.md b/doc/docs/index.md index 5f39f3b..dc41a02 100644 --- a/doc/docs/index.md +++ b/doc/docs/index.md @@ -12,4 +12,9 @@ Kurzer Überblick über das DIY-Lasertag-System auf Basis von nRF52840, Thread u - Konzept Software: Rolle Leader/Weste/Waffe, Game Loop, CoAP-API. - Konzept Hardware: Aufbau der Einheiten, LED-Treiber, Akku-Setup. +- Gameplay & Modi: [konzept/gameplay.md](konzept/gameplay.md) – Kurz erklärt, Rollen, Power-Ups und Spielmodi. - Planung: Zephyr-Workspace-Struktur und Roadmap. + +**Lizenz** + +- Inhalte stehen unter CC BY-NC-SA 4.0. Details unter [license.md](license.md). diff --git a/doc/docs/license.md b/doc/docs/license.md new file mode 100644 index 0000000..8faba1f --- /dev/null +++ b/doc/docs/license.md @@ -0,0 +1,9 @@ +# Lizenz + +Dieses Projekt steht unter der Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International (CC BY-NC-SA 4.0). + +- Kurzfassung: https://creativecommons.org/licenses/by-nc-sa/4.0/ +- Volltext: https://creativecommons.org/licenses/by-nc-sa/4.0/legalcode +- Repo-Lizenzdatei: https://gitea.iten.pro/edi/lasertag/src/branch/main/LICENSE + +Nutzung zu kommerziellen Zwecken ist nicht gestattet. Bearbeitungen muessen gleichartig geteilt werden und eine Namensnennung erfordern. diff --git a/doc/mkdocs.yml b/doc/mkdocs.yml index 99a60dc..73c5978 100644 --- a/doc/mkdocs.yml +++ b/doc/mkdocs.yml @@ -9,6 +9,7 @@ nav: - Software: konzept/software.md - Gameplay & Modi: konzept/gameplay.md - Planung: planung.md + - Lizenz: license.md theme: name: material