improve README

Former-commit-id: bdd8b27305607c6fefdace4c899f588ee6043f14 [formerly 8e1b58f8b1c77d2d1ac447b8ce35a86790470c04] [formerly 53a21cf2df60b8617d8c056049cc1e085e29fe32 [formerly e46061c5a6012724d006cb70491e0e4093943b99]]
Former-commit-id: e6fc999737a01f035a676daee7251149d3489698 [formerly 508c6f468b59d253df457ec59709c987e50f500f]
Former-commit-id: b73bf4fe97350ac3b302895c1781f1fb4336b4a1
This commit is contained in:
L3D 2018-11-04 23:46:25 +01:00
parent cc2127e464
commit 8aed0eff0f
2 changed files with 2489 additions and 3751 deletions

View file

@ -1,20 +1,83 @@
![C3WOC](https://c3woc.de/images/logo/c3woc.svg "C3WOC")
Die Seite [c3woc.de](https://c3woc.de) wird mithilfe des CMS [Lektor](https://getlektor.com) erstellt und bearbeitet.
Git clonen:
---
Status
------------
Dies ist der Quellcode der aktuellen Webseite des C3 Waffel Operation Center.
Diese findet man unter [c3woc.de](https://c3woc.de/)
Lektor CMS:
------------
Das CMS für diese Webseite ist [Lektor](https://www.getlektor.com/).
Die Installationsanleitung gibt es [hier](https://www.getlektor.com/downloads/).
Lektor ist auch als Python Modul verfügbar und kann mit ``python2 -m lektor`` verwendet werden.
Auch die Installation über pip *(in einem [virtuellen Enviroment](https://docs.python.org/3/tutorial/venv.html)* ist möglich:
```bash
git clone https://git.see-base.de/l3d/c3woc.git
cd c3woc
git submodule update --init --recursive
virtualenv venv
. venv/bin/activate
pip install lektor
```
Seite bearbeiten:
---
Zum Starten von Lektor muss man mit der Komandozeile in das root Verzeichnis der Webseite gehen
und dort mit dem Befehl ``lektor server`` startet man Lektor und öffnen auf 127.0.0.1 den Port 5000 über den die Webseite
bearbeitbar ist. Die Versionskontrolle der Webseite findet über Git statt. Daher wenn möglich Bilder erst
bearbeiten, bevor diese Veröffentlicht werden!
Zur neuen Webseite Beitragen:
------------------------
1. Dieses Repository Forken oder einen neuen Branch machen (übers GitHub Interface)
2. Geforktes Repository Clonen (``git clone https://github.com/<Your_Name>/c3woc-website.git``)
3. Öffne deine Komandozeile im geklonten Repository-Fork (``cd c3woc-website``)
4. Die Submodule Updaten *(optional, lädt nur das C3WOC Logo runter)* (`git submodule update --init --recursive``)
4. Lektor starten (``python2 -m lektor server``)
5. Webseite updaten... (``http://localhost:5000/``)
6. Lektor Beenden (``Strg. + C``)
7. Änderungen commiten (``git add --all; git commit -m "An der C3WOC Webseite habe ich _____ geändert"``)
8. Änderungen hochladen (``git push``)
9. Pull-Request Stellen (übers GitHub Interface)
Webseite übersetzen:
------------------------
Lektor bietet in der Admin-Oberfläche die Möglichkeit die C3WOC Webseite auf englisch zu übersetzen.
Diese Funktion befindet sich unter dem Punkt ``Alternative``.
Als Übersetzer mit guten Ergebnissen kann man beispielsweise [deepl](https://www.deepl.com) verwenden.<br/>
Links auf Seiten haben in der Englischen Version ein ``/en/`` vor der Adresse.
So wird ``https://c3woc.de/rezept/vegan/`` zu ``https://c3woc.de/en/rezept/vegan/``.
Fork aktuell halten ohne neu zu forken:
------------------------
```bash
lektor server
cd c3woc-website
# Das Original Repository der Toolbox einbinden:
git remote add upstream https://github.com/ToolboxBodensee/c3woc-website.git
git fetch upstream
# Deinen Fork lokal aktualisieren:
git pull upstream master
```
Pull Request Reviewen
-----------------------
1. Die im Pull-Request eingereite Version clonen ``git clone --depth 23 <REPO> -b <BRANCH> <ORDNERNAME>``
2. Den geklonten Pull-Request anschauen ``lektor server``
3. Änderungen requesten oder Pull-Request approven
Design:
---------
Das Design basiert auf [HTML5UP](https://html5up.net), genauer gesagt auf dem Design [Landed](https://html5up.net/landed). Und wurde natürlich für die Toolbox Webseite angepasst!
Bei den Menüfarben sollte die Farbauswahl aus dem [Toolbox Presse-Kit](https://github.com/ToolboxBodensee/presskit) berücksichtigt werden. ![#E64F2D](https://placehold.it/15/E64F2D/000000?text=+) `#E64F2D` Orange und ![#9B160F](https://placehold.it/15/9B160F/000000?text=+) `#9B160F` Rot sind hier die Primärfarben.
CSS:
------
Das CSS Design wird mit [sass](https://sass-lang.com/) generiert.
Das vereinfacht die Verständlichkeit der einzelnen Design Elemente
und ermöglicht auch das anpassen des Designs durch das simple verändern weniger variablen.
Example use:
```bash
sassc assets/sass/main.scss > assets/css/main.css
```
*Die Seite ist nun unter ``http://localhost:5000/`` erreichbar*

File diff suppressed because it is too large Load diff