Skip to content
Snippets Groups Projects
Commit 7b18f9c6 authored by orestis.malaspin's avatar orestis.malaspin
Browse files

Resolve "Add mdbook-linkcheck as a dependency"

parent 10f086b3
Branches
No related tags found
1 merge request!42Resolve "Add mdbook-linkcheck as a dependency"
......@@ -19,16 +19,53 @@ Pour compiler du code rust, il faut installer la chaîne de compilation et le co
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```
Après avoir installé la chaîne de compilation, vous pouvez également générer les résumés se trouvant dans le répertoire `book`. Pour ce faire il faut installer
le [mdbook](https://rust-lang.github.io/mdBook/)
Après avoir installé la chaîne de compilation, vous pouvez également générer les résumés se trouvant dans le répertoire `book` et `slides`.
Pour ce faire il faut installer plusieurs programmes:
* [mdbook](https://rust-lang.github.io/mdBook/) pour le livre et les slides,
* [modbook-linkcheck](https://github.com/Michael-F-Bryan/mdbook-linkcheck) pour la vérification des liens su livre,
* [mdslides](https://github.com/ferrous-systems/mdslides/), uniquement pour les slides.
### Installation de `mdbook`
Pour installer `mdbook` depuis la dernière version de <https://crates.io/>
```bash
cargo install mdbook
```
et exécuter les commandes
### Installation de `mdbook-linkcheck`
Pour installer `mdbook-linkcheck` depuis la dernière version de <https://crates.io/>
```bash
cargo install mdbook-linkcheck
```
Il est dès lors possible de générer le livre contenant les résumés des codes discutés en classe.
Pour ce faire exécuter les commandes
```bash
cd book
mdbook build
```
L'index du livre se trouve ensuite dans `book/html/index.html`.
### Installation de `mdslides`
Pour installer `mdslides`, il faut télécharger l'archive correspondant à vos besoins sur
[github](https://github.com/ferrous-systems/mdslides/releases), puis d'en extraire l'exécutable
dans votre `PATH`. Si vous êtes sous Linux vous pouvez faire les commandes suivantes
```bash
$ curl -sSL https://github.com/ferrous-systems/mdslides/releases/download/v0.3.0/mdslides-v0.3.0-x86_64-unknown-linux-gnu.tar.xz \
| tar -xJ "mdslides-v0.3.0-x86_64-unknown-linux-gnu/mdslides" \
&& mv mdslides-v0.3.0-x86_64-unknown-linux-gnu/mdslides $HOME/.cargo/bin/ \
&& rm -r mdslides-v0.3.0-x86_64-unknown-linux-gnu
```
qui installeront `mdslides` dans le répertoire `$HOME/.cargo/bin`.
Il est dès lors possible de générer les slides du cours.
Pour ce faire exécuter les commandes
```bash
$ cd slides
$ ./build_slides.sh
```
L'index des slides se trouve ensuite dans `slides/index.html`.
## Inspiration
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment