From 19903457f983f28c09f2bbbd1ad844db0a4f8968 Mon Sep 17 00:00:00 2001 From: Joshua Ramon Enslin Date: Sat, 1 Jan 2022 02:39:38 +0100 Subject: [PATCH] =?UTF-8?q?Readme=20hinzugef=C3=BCgt?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..a19e1a4 --- /dev/null +++ b/README.md @@ -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.