latex/latex-wochenende
5
0
Fork 0
Code Issues 8 Pull Requests Actions Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Knoch 2020-06-02 13:05:19 +02:00
parent 2901506bd8
commit 016862e7c1
1 changed files with 20 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -1,13 +1,26 @@
# LaTeX-Wochenende # LaTeX-Wochenende
In diesem Repository befinden sich die Präsentation und die Materialien für das LaTeX-Wochenende der Fachschaft WIAI. Für die Präsentation wurde auf [Reveal.js](https://revealjs.com) zurückgegriffen, dieses Repository ist ein Fork von Reveal.js. In diesem Repository befinden sich die Präsentation und die Materialien für das LaTeX-Wochenende der Fachschaft WIAI.
### Verwendung der Präsentation ## Verwendung der Präsentation
Die Präsentation benötigt eine aktuelle Version von [Node.js](https://nodejs.org/en/). Im Anschluss müssen untenstehende Befehle ausgeführt werden, um einen lokalen Server unter http://localhost:8000 zu starten. Zum Zeigen der Präsentation wird ein aktueller Browser benötigt. In diesem muss lediglich die Datei `slides.de.html` (bzw. `slides.en.html` für die englische Version) geöffnet werden.
## Anpassungen vornehmen
Um Inhalte der Präsentationen abzuändern oder zu ergänzen, muss zunächst das Repository geklont werden. Hierbei ist zu beachten, dass wir ein Submodul verwenden und deshalb eine zusätzliche Option beim Klonen notwendig ist:
```sh ```sh
$ cd path/to/latex-wochenende/presentation $ git clone -b 6-convert-to-onpoint --recurse-submodules https://git.stuve-bamberg.de/latex/latex-wochenende.git
$ npm install
$ npm start
``` ```
Zum Kompilieren der Präsentation werden python3 und pandoc verwendet. Als nächstes müssen alle benötigten Python-Pakete geladen werden.
```sh
$ cd latex-wochenende/onpoint
$ pip3 install -r requirements.txt
```
Damit sind alle benötigten Komponenten installiert. Mittels `python3 main.py ..` können alle Sprachversionen kompiliert werden. Danach stehen sie wie oben beschrieben als HTML-Dateien zur Verfügung.
Die Präsentation baut auf dem von uns entwickelten [onPoint-Präsentationswerkzeug](https://git.stuve-bamberg.de/ckremitzl/onpoint/) auf. Einen Überblick über die Verzeichnisstruktur und eine Anleitung zum automatischen Kompilieren bei jeder Änderung (unter Linux) finden sich [im zugehörigen README](https://git.stuve-bamberg.de/ckremitzl/onpoint/src/branch/master/README.md#the-project-structure).