diff --git a/README.adoc b/README.adoc new file mode 100644 index 0000000..23cae45 --- /dev/null +++ b/README.adoc @@ -0,0 +1,61 @@ += Projekt-Architektur & System-Handbuch +:toc: +:icons: font + +Ein technisches Logbuch für das Worldbuilding-Projekt "Computer History" (Maschinen-Instanzen). + +== 1. Die Infrastruktur (Sync & Git) + +Dieses Projekt nutzt eine strikte Trennung zwischen flüchtigen Arbeitsdaten und der finalen Lore-Datenbank. + +* **Single Source of Truth:** Gitea-Server (via Uberspace). Hier liegen die fertigen, versionierten Dateien. +* **Lokaler Puffer:** Ein Proxmox/NAS-System hält alle aktuellen Arbeitsdateien. +* **Der Client (Acer Spin5):** Dient lediglich als Terminal. Kann jederzeit formatiert oder ersetzt werden. +* **Synchronisation:** Syncthing verbindet den Client, das NAS und mobile Endgeräte nahtlos in Echtzeit. + +== 2. Mobile Editing (Android via Sideload) + +Ideen entstehen oft fernab der Tastatur. Das System ist für mobile Endgeräte vorbereitet: + +* **App:** Markor (Open Source Markdown/AsciiDoc Editor). +* **Installation:** Sideloading der APK (via F-Droid oder direktem GitHub-Release), um App-Store-Einschränkungen zu umgehen. +* **Workflow:** Die Android-Syncthing-App hält einen definierten Ordner (z. B. `99_Inbox`) synchron. Markor liest und schreibt direkt in diesen Ordner. + +== 3. Systemstart (Die isolierte Umgebung) + +Aus Sicherheitsgründen lädt Neovim lokale Konfigurationen nicht automatisch. Um die projektspezifischen Plugins und Tastenkürzel zu aktivieren, muss der Editor im Projektverzeichnis mit folgendem Befehl gestartet werden: + +[source,bash] +---- +nvim -u .nvim.lua +---- + +== 4. Neovim Cheatsheet + +Die wichtigsten Befehle für einen schnellen, tastaturgetriebenen Workflow, ohne den Editor zu verlassen. + +=== Projekt-Spezifische Kürzel (Leader = Leertaste) +* **[Leertaste] + b:** Führt das Skript `build.sh` aus (baut die Lore). +* **[Leertaste] + g + s:** Öffnet den Git-Status (via vim-fugitive) für Commits an Uberspace. + +=== Fenster-Management (Splits) +* **:vsp** -> Teilt das Fenster vertikal (Vertical Split). +* **:sp** -> Teilt das Fenster horizontal (Split). +* **Strg + w, dann h/j/k/l** -> Navigiert zwischen den geöffneten Fenstern (Links/Unten/Oben/Rechts). +* **:q** -> Schließt das aktuelle Fenster. + +=== Das Terminal in Neovim +* **:term** -> Öffnet ein Terminal innerhalb des Neovim-Fensters. +* **Strg + \ gefolgt von Strg + n** -> Der wichtigste Befehl! Holt dich aus dem Eingabemodus des Terminals zurück in den normalen Neovim-Modus, damit du das Terminal-Fenster mit `:q` schließen oder wechseln kannst. + +== 5. Verzeichnisstruktur + +Die Lore ist strikt modular aufgebaut. Alle AsciiDoc-Dateien dienen als Fragmente, die vom Build-Skript eingesammelt werden. + +* **01_Grundlagen:** Kernkonzepte des Universums. +* **02_Strukturen:** Politische oder physische Organisationen. +* **03_Charaktere:** Maschinen-Typen (z. B. Miner-Klasse). +* **04_Kult:** Religionen und In-Universe-Missverständnisse. +* **05_Tech:** Physikalische Erklärungen (z. B. Plasma-Trichter). +* **06_Regeln:** Verhaltensprotokolle (z. B. das Nina-Protokoll). +* **build.sh:** Das Skript, welches die Fragmente zur Master-Datei kompiliert.