Update installation instructions (#656)

deutsche-nationalbibliothek · Jul 12, 2023 · 3d43bee · 3d43bee
1 parent 5facd91
commit 3d43bee
Show file tree

Hide file tree

Showing 30 changed files with 59 additions and 38 deletions.
diff --git a/README.md b/README.md
@@ -29,12 +29,13 @@ In order to install the tools from source a
 [Rust](https://www.rust-lang.org/) installation is required. Just follow
 the [installation guide](https://www.rust-lang.org/learn/get-started) to
 get the Rust programming language with the `cargo` package manager. To
-build this project from source Rust 1.58.1 or newer is required.
+build this project from source Rust `1.70.0` or newer is required.
 
 To install the latest stable release:
 
 ```bash
-$ cargo install --git https://github.com/deutsche-nationalbibliothek/pica-rs --tag v0.17.0 pica
+$ cargo install --git https://github.com/deutsche-nationalbibliothek/pica-rs \
+    --tag v0.17.0 pica
 ```
 
 ## Commands

diff --git a/docs/book.bak/.gitignore b/docs/book.bak/.gitignore
@@ -0,0 +1 @@
+book
diff --git a/docs/book.bak/book.toml b/docs/book.bak/book.toml
@@ -0,0 +1,7 @@
+[book]
+authors = ["Nico Wagner"]
+src = "src/de"
+title = "pica-rs"
+
+[output.html]
+additional-css = ["custom.css"]
diff --git a/docs/book/custom.css → docs/book.bak/custom.css b/docs/book/custom.css → docs/book.bak/custom.css
diff --git a/docs/book/src/de/README.md → docs/book.bak/src/de/README.md b/docs/book/src/de/README.md → docs/book.bak/src/de/README.md
diff --git a/docs/book/src/de/SUMMARY.md → docs/book.bak/src/de/SUMMARY.md b/docs/book/src/de/SUMMARY.md → docs/book.bak/src/de/SUMMARY.md
diff --git a/docs/book/src/de/guide/cmds/cat.md → docs/book.bak/src/de/guide/cmds/cat.md b/docs/book/src/de/guide/cmds/cat.md → docs/book.bak/src/de/guide/cmds/cat.md
diff --git a/docs/book/src/de/guide/cmds/cat1.png → docs/book.bak/src/de/guide/cmds/cat1.png b/docs/book/src/de/guide/cmds/cat1.png → docs/book.bak/src/de/guide/cmds/cat1.png
diff --git a/docs/book/src/de/guide/cmds/cat2.png → docs/book.bak/src/de/guide/cmds/cat2.png b/docs/book/src/de/guide/cmds/cat2.png → docs/book.bak/src/de/guide/cmds/cat2.png
diff --git a/docs/book/src/de/guide/cmds/completions.md → ...book.bak/src/de/guide/cmds/completions.md b/docs/book/src/de/guide/cmds/completions.md → ...book.bak/src/de/guide/cmds/completions.md
diff --git a/docs/book/src/de/guide/cmds/count.md → docs/book.bak/src/de/guide/cmds/count.md b/docs/book/src/de/guide/cmds/count.md → docs/book.bak/src/de/guide/cmds/count.md
diff --git a/docs/book/src/de/guide/cmds/frequency.md → docs/book.bak/src/de/guide/cmds/frequency.md b/docs/book/src/de/guide/cmds/frequency.md → docs/book.bak/src/de/guide/cmds/frequency.md
diff --git a/docs/book/src/de/guide/cmds/invalid.md → docs/book.bak/src/de/guide/cmds/invalid.md b/docs/book/src/de/guide/cmds/invalid.md → docs/book.bak/src/de/guide/cmds/invalid.md
diff --git a/docs/book/src/de/referenz/index.md → docs/book.bak/src/de/referenz/index.md b/docs/book/src/de/referenz/index.md → docs/book.bak/src/de/referenz/index.md
diff --git a/docs/book/src/de/referenz/matcher.md → docs/book.bak/src/de/referenz/matcher.md b/docs/book/src/de/referenz/matcher.md → docs/book.bak/src/de/referenz/matcher.md
diff --git a/docs/book/src/de/referenz/occurrence.md → docs/book.bak/src/de/referenz/occurrence.md b/docs/book/src/de/referenz/occurrence.md → docs/book.bak/src/de/referenz/occurrence.md
diff --git a/docs/book/src/de/referenz/subfield.md → docs/book.bak/src/de/referenz/subfield.md b/docs/book/src/de/referenz/subfield.md → docs/book.bak/src/de/referenz/subfield.md
diff --git a/docs/book/src/de/referenz/tag.md → docs/book.bak/src/de/referenz/tag.md b/docs/book/src/de/referenz/tag.md → docs/book.bak/src/de/referenz/tag.md
diff --git a/...ook/src/de/tutorials/beginner-tutorial.md → ...bak/src/de/tutorials/beginner-tutorial.md b/...ook/src/de/tutorials/beginner-tutorial.md → ...bak/src/de/tutorials/beginner-tutorial.md
diff --git a/...torials/rmarkdown/plots/plot_freq_-1.jpeg → ...torials/rmarkdown/plots/plot_freq_-1.jpeg b/...torials/rmarkdown/plots/plot_freq_-1.jpeg → ...torials/rmarkdown/plots/plot_freq_-1.jpeg
diff --git a/...utorials/rmarkdown/plots/term_dist-1.jpeg → ...utorials/rmarkdown/plots/term_dist-1.jpeg b/...utorials/rmarkdown/plots/term_dist-1.jpeg → ...utorials/rmarkdown/plots/term_dist-1.jpeg
diff --git a/...k/src/de/tutorials/rmarkdown/rmarkdown.md → ...k/src/de/tutorials/rmarkdown/rmarkdown.md b/...k/src/de/tutorials/rmarkdown/rmarkdown.md → ...k/src/de/tutorials/rmarkdown/rmarkdown.md
diff --git a/.../src/de/tutorials/rmarkdown/rmarkdown.rmd → .../src/de/tutorials/rmarkdown/rmarkdown.rmd b/.../src/de/tutorials/rmarkdown/rmarkdown.rmd → .../src/de/tutorials/rmarkdown/rmarkdown.rmd
diff --git a/docs/book/src/de/tutorials/testdaten.dat → docs/book.bak/src/de/tutorials/testdaten.dat b/docs/book/src/de/tutorials/testdaten.dat → docs/book.bak/src/de/tutorials/testdaten.dat
diff --git a/docs/book/book.toml b/docs/book/book.toml
@@ -1,7 +1,15 @@
 [book]
 authors = ["Nico Wagner"]
-src = "src/de"
+language = "de"
+multilingual = false
 title = "pica-rs"
+src = "src"
 
-[output.html]
-additional-css = ["custom.css"]
+[build]
+create-missing = false
+
+[rust]
+edition = "2021"
+
+[output.html.search]
+limit-results = 15
diff --git a/docs/book/src/SUMMARY.md b/docs/book/src/SUMMARY.md
@@ -0,0 +1,8 @@
+# Summary
+
+- [Tutorials](./tutorials/index.md)
+
+- [Anleitungen](./anleitungen/index.md)
+    - [Installation](./anleitungen/installation.md)
+
+- [Referenz](./referenz/index.md)
diff --git a/docs/book/src/anleitungen/index.md b/docs/book/src/anleitungen/index.md
@@ -0,0 +1 @@
+# Anleitungen
diff --git a/docs/book/src/de/guide/installation.md → docs/book/src/anleitungen/installation.md b/docs/book/src/de/guide/installation.md → docs/book/src/anleitungen/installation.md
@@ -1,37 +1,34 @@
 # Installation
-
-Das Toolkit _pica-rs_ kann unter Linux, macOS und Windows verwendet werden. Für diese
-Betriebssysteme stehen unterschiedliche Pakete zum
+Das Toolkit _pica-rs_ kann unter Linux, macOS und Windows verwendet
+werden. Für diese Betriebssysteme stehen unterschiedliche Pakete zum
 [Download auf GitHub](https://github.com/deutsche-nationalbibliothek/pica-rs/releases)
 bereit.
 
 ## Debian & Ubuntu
 
-Beginnend mit der Version `0.10.0` stehen für die Linux-Distributionen
-[Debian](https://www.debian.org/) sowie [Ubuntu](https://ubuntu.com/) fertige
-`DEB`-Pakete zum Download bereit. Diese können mit folgendem Kommando heruntergeladen und installiert
-werden:
+Für [Debian](https://www.debian.org/) sowie
+[Ubuntu](https://ubuntu.com/) stehen fertige `DEB`-Pakete zum Download
+bereit. Diese können mit folgendem Kommando heruntergeladen und
+installiert werden:
 
 ```bash
-$ wget https://github.com/deutsche-nationalbibliothek/pica-rs/releases/download/v0.17.0/pica_0.17.0-glibc2.31-1_amd64.deb
-$ dpkg -i pica_0.17.0-glibc2.31-1_amd64.deb
-$ rm pica_0.17.0-glibc2.31-1_amd64.deb
+$ dpkg -i pica_0.17.0-glibc2.35-1_amd64.deb
 ```
 
 ## RedHat & SUSE & CentOS
 
-Beginnend mit der Version `0.10.0` stehen für die Linux-Distributionen
-[RedHat](https://www.redhat.com/), [SUSE](https://www.suse.com/) und
-[CentOS](https://www.centos.org/) stehen fertige `RPM` zum Download bereit. Diese können
-mit folgendem Kommando installiert werden:
+Für [RedHat](https://www.redhat.com/), [SUSE](https://www.suse.com/) und
+[CentOS](https://www.centos.org/) stehen fertige `RPM`-Pakete zum
+Download bereit. Diese können mit folgendem Kommando installiert werden:
 
 ```bash
-$ rpm -i pica-0.17.0-glibc2.31-1.x86_64.rpm
+$ rpm -i pica-0.17.0-glibc2.35-1.x86_64.rpm
 ```
 
-Für CentOS 7 steht ein spezielles `RPM`-Paket bereit (`pica-0.17.0-glibc2.17-1.x86_64.rpm`),
-dass die [GNU C Library (glibc)](https://www.gnu.org/software/libc) in der Version 2.17
-verwendet.
+Für altere Distributionen (bspw. CentOS 7) stehen spezielle `RPM`-Pakete
+bereit, die eine ältere Version der
+[GNU C Library (glibc)](https://www.gnu.org/software/libc) verwenden
+(`2.17` und `2.31`).
 
 ## Binary-Releases
 
@@ -49,15 +46,11 @@ Folgende Architekturen werden unterstützt:
 | x86_64-pc-windows-gnu    | 64-bit MinGW (Windows 7+)                  |
 | i686-pc-windows-msvc     | 32-bit MSVC (Windows 7+)                   |
 
-Für die Zielarchitektur `x86_64-unknown-linux-gnu` steht noch ein weiteres Binary für
-Betriebssysteme, die die [GNU C Library (glib)](https://www.gnu.org/software/libc)
-in der Version 2.17 verwenden, bereit.
-
 ## Installation aus den Quellen
 
-Das Projekt lässt sich auch direkt aus den Quellen kompilieren. Hierfür wird eine
-aktuelle [Rust](https://www.rust-lang.org/)-Version (`>= 1.58`) mit dem Paketmanager
-`cargo` benötigt.
+Das Projekt lässt sich auch direkt aus den Quellen kompilieren. Hierfür
+wird eine aktuelle [Rust](https://www.rust-lang.org/)-Version (`>=
+1.70.0`) mit dem Paketmanager `cargo` benötigt.
 
 Der aktuelle Entwicklungsstand lässt sich wie folgt installieren:
 
@@ -67,23 +60,22 @@ $ cd pica-rs
 $ cargo build --release
 ```
 
-Das fertige Release-Binary befindet sich im Verzeichnis `target/release/pica`.
-
-Wenn die Quelle nicht benötigt werden, kann das Projekt auch direkt über den Paketmanager
-`cargo` installiert werden:
+Wenn die Quelle nicht benötigt werden, kann das Projekt auch direkt über
+den Paketmanager `cargo` installiert werden:
 
 ```bash
 # Installation des aktuellen Entwicklungsversion
 $ cargo install --git https://github.com/deutsche-nationalbibliothek/pica-rs \
-     --branch main pica
+     --branch main pica-toolkit
 
 # Installation der Version 0.17.0
 $ cargo install --git https://github.com/deutsche-nationalbibliothek/pica-rs \
-      --tag v0.17.0 pica
+      --tag v0.17.0 pica-toolkit
 
 # Installation des Entwicklungszweigs "feat1"
 $ cargo install --git https://github.com/deutsche-nationalbibliothek/pica-rs \
-      --branch feat1 pica
+      --branch feat1 pica-toolkit
 ```
 
-Das fertige Programm befindet sich dann im Verzeichnis `.cargo/bin`.
+Das fertige Release-Binary `pica` liegt im Verzeichnis
+`target/release/`.
diff --git a/docs/book/src/referenz/index.md b/docs/book/src/referenz/index.md
@@ -0,0 +1,2 @@
+# Referenz
+
diff --git a/docs/book/src/tutorials/index.md b/docs/book/src/tutorials/index.md
@@ -0,0 +1 @@
+# Tutorials