From 127778123f4f8fea06c6304baed0b4abb22d441c Mon Sep 17 00:00:00 2001 From: L3D <16953664+DO1JLR@users.noreply.github.com> Date: Fri, 15 Feb 2019 20:37:13 +0100 Subject: [PATCH] improved readme and gitignore (#231) * expand gitignore + add comments expand .gitignore and add comments to readme: lektor installation and add gem install sass * Add git-lfs on the top of the page * Add help to reset repo --- .gitignore | 3 +++ README.md | 13 +++++++++++-- 2 files changed, 14 insertions(+), 2 deletions(-) diff --git a/.gitignore b/.gitignore index 40becc30..5781ce7c 100644 --- a/.gitignore +++ b/.gitignore @@ -48,3 +48,6 @@ assets/css/ie9.css.map assets/css/main.min.css.map assets/css/ie9.min.css.map +# python virtual enviroment +venv/ + diff --git a/README.md b/README.md index 7e7a8b9b..05fee9f9 100644 --- a/README.md +++ b/README.md @@ -13,20 +13,28 @@ Dies ist der Quellcode zur aktuellen Webseite des Maker- und Hackspace Toolbox B Lektor CMS ------------------------ -Das CMS für diese Webseite ist [Lektor](https://www.getlektor.com/). -Die Installationsanleitung gibt es [hier](https://www.getlektor.com/downloads/). +Das CMS für diese Webseite ist [Lektor](https://www.getlektor.com/).
+Die Installationsanleitung gibt es [hier](https://www.getlektor.com/downloads/).
+Für Bilder im git verwenden wir [git-lfs](https://git-lfs.github.com/). Weitere Informationen dazu gibt es [weiter untern](https://github.com/toolboxbodensee/toolbox-webseite#bilder-und-gro%C3%9Fe-dateien).
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 +# create virtual enviroment virtualenv venv +# activate virtual enviroment . venv/bin/activate +# install lektor to virtual enviroment pip install lektor + +# install ruby-sass (for css styles) +gem install sass ``` Zum Starten von Lektor muss man mit der Komandozeile in das root-Verzeichnis der Webseite gehen und dort mit dem Befehl ``lektor server`` Lektor starten. Im Browser kann dann 127.0.0.1:5000 aufgerufen werden, um die Webseite zu bearbeiten. Die Versionskontrolle der Webseite findet über Git statt. Daher wenn möglich Bilder erst bearbeiten, bevor diese veröffentlicht werden! + Zur Webseite Beitragen ------------------------ @@ -77,6 +85,7 @@ git fetch upstream # Deinen Fork lokal aktualisieren: git pull upstream master +git reset --hard upstream/master ``` Pull Request Reviewen