Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update install readme #24

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
134 changes: 111 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,14 @@
# Tanzkarten
# LaTeX Tanzkarten für Historische und davon inspirierte Tänze
## LaTeX Tanzkarten für Historische und davon inspirierte Tänze

## [Für Tanzkarten zum Ball in Wuppertal 2022 immer hier entlang](https://github.com/Phayax/dance-cards/blob/ball-2022/BALL.md)
### [Für Tanzkarten zum Ball in Wuppertal 2022 immer hier entlang](https://github.com/Phayax/dance-cards/blob/ball-2022/BALL.md)

## Download

[Tanzkarten A6 - Alle Tänze zusammen](https://github.com/Phayax/dance-cards/releases/latest/download/Tanzanleitungen.pdf)
[Tanzkarten A6 - Ein Tanz pro PDF](https://github.com/Phayax/dance-cards/releases/latest/download/Tanzanleitungen-einzeln.zip)

# Verwendung
### Druck
## Druck
Die Karten können zum Beispiel mit Adobe Acrobat auf A4 Papier gedruckt werden (immer 4 auf eine Seite).
Papier schwerer als 200g/m² liefert schöne Ergebnisse.

Expand All @@ -28,35 +27,124 @@ Wenn man die Karten doppelseitig drucken möchte, muss man die richtigen Seiten

Während die A6 Karten 0,5cm Rand haben, was die meisten Drucker gut schaffen müssten, wird der Rand bei den kleiner Formaten weniger als 0,5cm sein. Hier muss man eventuell die Seitengröße im PDF-Programm leicht anpassen.

## Vorlage weiterverwenden
Empfohlene Software:
## Eigene Tanzkarten erstellen
Klone das Repository mit Git um änderungen vorzunehmen:

```bash
mkdir ~/remote
cd ~/remote
git clone https://github.com/Phayax/dance-cards.git
```
Zum Verändern und Hinzufügen von Tänzen braucht man LaTeX, für das Setzen der Karten Python.

### LaTeX Installation - Tänze hinzufügen

Die Tänze sind in TeX Skript geschrieben. Empfohlene Software:

- [TeXstudio](https://www.texstudio.org/) als Editor
- [TeX Live](https://www.tug.org/texlive/) um die PDFs zu erstellen. Unter Windows kann man auch [MiKTeX ](https://miktex.org/) verwenden, das aber deutlich langsamer mit den Karten ist.

- [TeX Live](https://www.tug.org/texlive/) um die PDFs zu erstellen.

- Unter Windows kann man auch [MiKTeX ](https://miktex.org/) verwenden, das aber deutlich langsamer mit den Karten ist.

- Ubuntu macht die Installation dieser Pakete sehr einfacher:
```
```bash
sudo apt install texstudio
sudo apt install texlive-full # braucht viel Speicherplatz, aber man hat alles...
```
Windows ist natürlich aber auch möglich.
- [Python](https://www.python.org/), wenn man die aufgeteilten PDFs erstellen möchte.

Nun kann man [`cards.tex`](https://github.com/Phayax/dance-cards/blob/main/cards.tex) in TeXstudio öffnen und beliebige Änderungen vornehmen.
## Erstellen
Um das PDF zu erstellen empfiehlt sich latexmk. Dafür sollte [`.latexmkrc`](https://github.com/Phayax/dance-cards/blob/main/.latexmkrc) im selben Verzeichnis wie cards.tex liegen. Dann lassen sich die Tanzkarten mit
Nun kann man [`cards.tex`](https://github.com/Phayax/dance-cards/blob/main/cards.tex) in TeXstudio öffnen und beliebige Änderungen vornehmen.

Kompiliere die Tanzkarten mit

```bash
cd ~/remote/dance-cards
latexmk cards.tex
```

Wenn das Kommande erfolgreich durchläuft liegt das erstellte PDF in `cards.pdf`.

### Python Installation - Tanzkarten setzen

Die bereits fertig gesetzten Tanzkarten stehen oben zum Download zur Verfügung. Um nur ein paar der Tänze als PDF zu verpacken und die notwendigen Skripte zum setzen der Tanzkarten auszuführen braucht man mindestens Python 3.11.

```bash
python -V
```

Falls die Version zu niedrig ist, installiere so [Python](https://www.python.org/downloads/) 3.11

```bash
sudo add-apt-repository ppa:deadsnakes/ppa
sudo apt update
sudo apt install python3.11 python3.11-venv
```

Erstelle eine Python Umgebung

```bash
mkdir ~/.venvs
python3.11 -m venv ~/.venvs/dance-cards
source ~/.venvs/dance-cards/bin/activate

python -V # sollte nun 3.11.xx anzeigen
pip --version # sollte auf das venv zeigen
```

Installiere die requirements

```bash
cd ~/remote/dance-cards
pip install -r requirements
```

Nun können die Skripte [split.py](https://github.com/Phayax/dance-cards/blob/main/split.py) und [multi-gui.py](https://github.com/Phayax/dance-cards/blob/main/multi-gui.py) ausgeführt werden.

### Karten kompilieren, splitten, zusammenfügen

Um das PDF zu erstellen empfiehlt sich latexmk. Dafür sollte [`.latexmkrc`](https://github.com/Phayax/dance-cards/blob/main/.latexmkrc) im selben Verzeichnis wie cards.tex liegen.

Kompiliere alle Tanzkarten. Siehe die `cards.pdf` Datei bei Erfolg.

````bash
cd ~/remote/dance-cards
latexmk cards.tex
````

Spalte die Karten in einzelne:

```bash
source ~/.venvs/dance-cards/bin/activate
python split.py
```

Kompiliere die einzelnen Karten:

```bash
cd split
latexmk *.tex
cd ..
```

`latexmk cards.tex`
Öffne die Tanzauswahl:

erstellen (das Ergebnis liegt dann im Ordner `.build/`).
<hr>
Um die Einzelkarten zu erstellen, muss mit python die Datei [`compile.py`](https://github.com/Phayax/dance-cards/blob/main/compile.py) aufgerufen werden:
```bash
python multi-gui.py
```

```python compile.py```
![tanz-gui](./img/multi-gui.png)

Danach kann in dem Ordner `build-single-temp/` einfach nur
* Wähle oben das gesamte PDF aus, dann den Ordner in dem die einzelnen Tänze liegen.
Nun sollten die `Verfügbaren Tänze` erscheinen.
* Wähle rechts die gewünschte Kartengröße aus
* und ob das doppelseitige PDF beim Druck über die kurze oder lange Seite gedreht werden soll.
Tip: `Kurze Seite` behält das PDF besser lesbar, `Lange Seite` ist die Standardeinstellung der meisten Drucker.
* Klicke auf `Create Multipage PDF`

`latexmk`
Dies erschafft eine neue TeX Datei. Kompiliere ein 3x3 (A7) mit Falz zur kurzen Seite so:

ausgeführt werden. Alle Tanzkarten werden dann im Ordner `.build/` erzeugt.
```
latexmk multi_cards_3x3_fold_short_tex
```

<br/>
<br/>
Das gebaute `multi_cards_3x3_fold_short_.pdf` ist das Ergebnis.
Binary file added img/multi-gui.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.