Sarted writting a user manual
This commit is contained in:
parent
fe9992030c
commit
48d4f3863a
8 changed files with 35 additions and 0 deletions
1
.gitignore
vendored
1
.gitignore
vendored
|
@ -1 +1,2 @@
|
|||
**.FCBak
|
||||
manual/**.html
|
|
@ -13,6 +13,8 @@ _\[**Version francaise traduite automatiquement avec peu d'éffort de relecture*
|
|||
|
||||
Voici la [page printables](https://www.printables.com/model/1114079-parametric-gas-mask) de ce modèle.
|
||||
|
||||
**_Il existe un manuel utilisateur - qui inclu un guide de démarrage rapide - qui se trouve au chemin [manual/manuel-utilisateur.md](./manual/manuel-utilisateur.md) ou sous la forme d'un fichier pdf imprimable au chemin [manual/manuel-utilisateur.pdf](./manual/manuel-utilisateur.pdf)._**
|
||||
|
||||
## 1 - Principe général
|
||||
|
||||
Il y a eu plusieurs versions majeures (8 au total) de ce masque à gaz avant d'arriver à un design final.
|
||||
|
|
|
@ -14,6 +14,8 @@ _\[**English version automatically spell checked with minimum effort put into pr
|
|||
|
||||
Here is the [printable page](https://www.printables.com/model/1114079-parametric-gas-mask) for this model.
|
||||
|
||||
**_There is user manual - including a quick-start guide - found at [manual/user-manual.md](./manual/user-manual.md) or as a printable pdf file at [manual/user-manual.pdf](./manual/user-manual.pdf)._**
|
||||
|
||||
## 1 - General principle
|
||||
|
||||
There was many major version (8 in total) of this gas mask before arriving at a final design.
|
||||
|
|
13
manual/convert-to-pdf.sh
Executable file
13
manual/convert-to-pdf.sh
Executable file
|
@ -0,0 +1,13 @@
|
|||
#!/bin/bash
|
||||
|
||||
files=$(ls *.md)
|
||||
|
||||
OIFS="$IFS"
|
||||
IFS=$'\n'
|
||||
for file in $files; do
|
||||
tmpfile=.$(basename "${file%.*}").html
|
||||
outfile=$(basename "${file%.*}").pdf
|
||||
pandoc -f markdown+emoji -t html -o $tmpfile $file
|
||||
pandoc -f html -t pdf -o $outfile $tmpfile --pdf-engine=lualatex -V geometry:margin=2.5cm -V mainfont="DejaVu Sans"
|
||||
done
|
||||
IFS=$OIFS
|
8
manual/manuel-utilisateur.md
Normal file
8
manual/manuel-utilisateur.md
Normal file
|
@ -0,0 +1,8 @@
|
|||
# manuel utilisateur
|
||||
|
||||
## 1 - Guide de démarrage rapide
|
||||
|
||||
_À completer_
|
||||
|
||||
## 2 - Maintenance du masque
|
||||
|
BIN
manual/manuel-utilisateur.pdf
Normal file
BIN
manual/manuel-utilisateur.pdf
Normal file
Binary file not shown.
9
manual/user-manual.md
Normal file
9
manual/user-manual.md
Normal file
|
@ -0,0 +1,9 @@
|
|||
# User manual
|
||||
|
||||
## 1 - Quick start guide
|
||||
|
||||
_To do_
|
||||
|
||||
## 2 - Maintenance of the mask
|
||||
|
||||
_To do_
|
BIN
manual/user-manual.pdf
Normal file
BIN
manual/user-manual.pdf
Normal file
Binary file not shown.
Loading…
Reference in a new issue