Readme hinzugefügt

This commit is contained in:
Joshua Ramon Enslin 2022-01-01 02:39:38 +01:00
parent aa3a27a293
commit 19903457f9
Signed by: jrenslin
GPG Key ID: 46016F84501B70AE

19
README.md Normal file
View File

@ -0,0 +1,19 @@
# Deutschsprachiges Handbuch für museum-digital
## Rendering
### Umgebung aufsetzen
Um das Handbuch zu rendern wird die Rust-Toolchain gebraucht. Mehr dazu findet sich auf der Rust-Downloadseite: https://www.rust-lang.org/tools/install.
Sind Rust und sein Paketmanager cargo installiert, können die benötigten Pakete rund um mdbook, auf dem das Handbuch basiert, installiert werden:
```
cargo install mdbook
cargo install mdbook-rss
cargo install mdbook-linkcheck
```
### Ausgabe generieren
Das Handbuch kann im folgenden mit dem Befehl `mdbook build` generiert werden.