diff --git a/README.md b/README.md index 6a5a87000b9cc40edad668a3a8db7ebaaeebc5de..585c2de8e9afb8754da4f57a23314bb796c4e36b 100644 --- a/README.md +++ b/README.md @@ -26,24 +26,17 @@ Die folgenden Befehle sind für Ubuntu 20.04 LTS (Focal) gedacht. 1. Pakete installieren: `apt-get update && apt-get install -y --no-install-recommends python3-pip python3 make git wget software-properties-common` 1. Pandoc 2.18 installieren: `wget -O pandoc.deb https://github.com/jgm/pandoc/releases/download/2.18/pandoc-2.18-1-amd64.deb && dpkg -i pandoc.deb && rm --interactive=never pandoc.deb` -1. [Abgeändertes Pelican](https://gitlab.gwdg.de/GAUMI-fginfo/pelican) installieren oder aktualisieren: `./installpelican.sh` -1. Python Pakete installieren: `pip3 install tzlocal markdown pelican-pandoc-reader gitpython typogrify` 1. Metarepo klonen: `git clone --recurse-submodules git@gitlab.gwdg.de:GAUMI-fginfo/fg-website.git` 1. `cd fg-website` +1. Python Pakete installieren: `pip3 install -r requirements.txt` 1. Inhaltsrepo klonen: `git clone git@gitlab.gwdg.de:GAUMI-fginfo/fg-website-data.git content` ### (Automatisch) Bauen und Hosten -Die Seite kann nun relativ einfach mit `make html` gebaut werden. -Dabei wird die [pelicanconf.py](pelicanconf.py) Datei als Config verwendet. +Die Seite kann nun relativ einfach mit `make` gebaut werden. +Dabei wird die [config.json](config.json) Datei als Config verwendet. Die Ausgabe befindet sich im `output` Ordner. -Mit `make publish` kann die Seite auch mit der [publishconf.py](publishconf.py) Datei gebaut werden. -Dies ist die selbe Config, die auch die tatsächliche Webseite zum Schluss verwendet. -In den meisten Fällen möchte man beim Entwickeln aber die oben genannte [pelicanconf.py](pelicanconf.py) Datei verwenden. - -Um die Seite lokal zu hosten und automatisch neu zu bauen, wenn eine Datei bearbeitet wurde, kann `make devserver` verwendet werden. +Um die Seite lokal zu hosten kann `make devserver` verwendet werden. Die Seite kann man dann unter [http://127.0.0.1:8000](http://127.0.0.1:8000) finden. -Die Seite wird zwar automatisch neu gebaut, aber es ist dennoch notwendig im Browser die Seite neu zu laden um die Veränderungen zu sehen. - -Für weitere mögliche Befehle führe einfach `make help` aus. +Die Seite wird **nicht** automatisch neu gebaut. Man muss also `make` manuell ausführen um die Seite neuzubauen.