Entwicklungsvorlage für eine neue Readme.md

2025-08-05 02:34:47 +02:00 · 2025-02-13 08:16:42 +01:00 · 2025-02-13 08:16:42 +01:00 · 12bd066a0b
commit 12bd066a0b
parent 3119144ea8
2 changed files with 111 additions and 23 deletions
--- a/README.md
+++ b/README.md
@ -1,28 +1,88 @@
-# Startodon-Hub
+```markdown
+# Fedikirche

-Ein Hub, auf dem sich Instanzen mit Startodon-Seite gemeinsam vorstellen.
+**Die digitale Plattform für Kirche im Fediverse**
+
+<div align="center">
+   <img src="images/fedikirche-logo.png" alt="Logo von Fedikirche" width="600">
+</div>
+
+Dies ist der Quellcode für die Landingpage **[fedikirche.de](https://fedikirche.de)** – eine moderne Plattform, die kirchliche Gemeinschaften im Fediverse vernetzt. Unser Ziel ist es, durch den Einsatz freier und dezentraler Technologien eine offene digitale Vernetzung zu fördern und den Einstieg in die Welt des Fediverse zu erleichtern.

 ---

-Überlegungen zur Entwicklung:
+## 📋 Überblick

- [ ] Empfehlungen umbauen
-    - mehrere Starterkits erstellen & auflisten
-        - katholisch
-        - evangelisch
-        - ökumenisch
-        - Initiativen
-        - gemeinsam beten
-        - Aktionen: Kirchentag, ...
-    - als PopUp die Accounts im Starterkit anzeigen
-    - Informationen zum Kit
-        - Anzahl der Accounts
-        - wer hat das Kit erstellt und ist Ansprechpartner
-        - zuletzt aktualisiert?
- [ ] Instanz-Cards um weitere Informationen ergänzen
-    - Admin
-    - Flavours, wie bspw. friendica.katholisch.social
- [ ] Onboarding in Mastodon?
-    - (informieren) Gründe für das Fediverse aufzeigen?
-    - (zeigen) auf die jeweiligen Startseiten verweisen?
- [ ] Readme für das Repository schreiben
+Fedikirche bietet:
+- **Informationen**: Aktuelle Neuigkeiten und Anleitungen rund um die digitale Kirche.
+- **Einstiegshilfen**: Tipps und Tutorials für den Einstieg ins Fediverse.
+- **Interaktive Inhalte**: Dynamische Darstellung von Empfehlungen und Community-Updates.
+- **Vernetzung**: Direkte Links zu sozialen Profilen und weiterführenden Ressourcen.
+
+---
+
+## 🚀 Features
+
+- **Modernes Design**: Klare Navigation und ansprechende visuelle Gestaltung.
+- **Interaktive Elemente**: Dynamische Inhalte und Empfehlungen, die zum Mitmachen anregen.
+- **Open-Source**: Der Quellcode ist frei verfügbar und lädt zur Weiterentwicklung ein.
+- **Fediverse-Integration**: Nahtlose Einbindung von Social-Media-Tools und APIs.
+
+---
+
+## 🛠️ Installation und Nutzung
+
+Um die Seite lokal zu testen oder anzupassen, folge diesen Schritten:
+
+1. **Repository klonen**:
+   ```bash
+   git clone https://codeberg.org/kirche-im-netz/Startodon-Hub.git
+   cd Startodon-Hub
+   ```
+
+2. **Ressourcen prüfen**: Vergewissere dich, dass alle notwendigen Dateien (z. B. fonts/, images/, style.css, code.js) vorhanden sind.
+
+3. **Im Browser öffnen**: Starte die Anwendung, indem du die Datei `index.html` in deinem Browser öffnest.
+
+4. **Anpassungen vornehmen**: Bearbeite die HTML-, CSS- oder JS-Dateien, um die Seite nach deinen Vorstellungen zu personalisieren:
+   - Aktualisiere in der `index.html` alle relevanten Links und Informationen.
+   - Passe in der `style.css` die Farbgebung und andere Designaspekte an.
+
+---
+
+## ⚖️ Lizenz
+
+Der Quellcode von Fedikirche steht unter der **MIT-Lizenz**:
+
+- Du darfst den Code frei nutzen, verändern und weiterverbreiten.
+- Die vollständigen Lizenzbedingungen findest du in der Datei `LICENSE`.
+
+Hinweis: Die verwendeten Bilder unterliegen teilweise eigenen Lizenzen. Genauere Informationen dazu findest du im Verzeichnis `images/`.
+
+---
+
+## 📚 Abhängigkeiten
+
+- **Roboto**: Schriftart von Google Fonts (Apache License 2.0).
+- **kjua**: QR Code Generator (MIT License) – sofern in der dynamischen Darstellung genutzt.
+- **Fediverse-APIs**: Für die Integration von Social-Media-Funktionen und dynamischen Inhalten.
+
+---
+
+## 🧑‍🏭 Beitragende
+
+Wir freuen uns über jede Art von Feedback und Unterstützung! So kannst du beitragen:
+
+- **Issues erstellen**: Melde Fehler oder mache Verbesserungsvorschläge.
+- **Pull Requests einreichen**: Bringe deine Ideen ein, indem du den Code oder Inhalte verbesserst.
+
+---
+
+## Code of Conduct
+
+Wir legen großen Wert auf eine offene, respektvolle und konstruktive Zusammenarbeit. Bitte beachte unseren Verhaltenskodex, um eine angenehme und produktive Community zu fördern.
+
+---
+
+Vielen Dank für dein Interesse und deine Unterstützung! 🌟
+```
--- a/docs/Entwicklungsnotizen
+++ b/docs/Entwicklungsnotizen
@ -0,0 +1,28 @@
+# Startodon-Hub
+
+Ein Hub, auf dem sich Instanzen mit Startodon-Seite gemeinsam vorstellen.
+
+---
+
+Überlegungen zur Entwicklung:
+
+- [ ] Empfehlungen umbauen
+    - mehrere Starterkits erstellen & auflisten
+        - katholisch
+        - evangelisch
+        - ökumenisch
+        - Initiativen
+        - gemeinsam beten
+        - Aktionen: Kirchentag, ...
+    - als PopUp die Accounts im Starterkit anzeigen
+    - Informationen zum Kit
+        - Anzahl der Accounts
+        - wer hat das Kit erstellt und ist Ansprechpartner
+        - zuletzt aktualisiert?
+- [ ] Instanz-Cards um weitere Informationen ergänzen
+    - Admin
+    - Flavours, wie bspw. friendica.katholisch.social
+- [ ] Onboarding in Mastodon?
+    - (informieren) Gründe für das Fediverse aufzeigen?
+    - (zeigen) auf die jeweiligen Startseiten verweisen?
+- [ ] Readme für das Repository schreiben