Skip to content

Commit

Permalink
improved readme and gitignore (#231)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
DO1JLR committed Feb 15, 2019
1 parent d2f0d96 commit 1277781
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 2 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Expand Up @@ -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/

13 changes: 11 additions & 2 deletions README.md
Expand Up @@ -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/).<br/>
Die Installationsanleitung gibt es [hier](https://www.getlektor.com/downloads/).<br/>
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).<br/>
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
------------------------

Expand Down Expand Up @@ -77,6 +85,7 @@ git fetch upstream

# Deinen Fork lokal aktualisieren:
git pull upstream master
git reset --hard upstream/master
```

Pull Request Reviewen
Expand Down

0 comments on commit 1277781

Please sign in to comment.