Renamed build docs script reference, removed extraneous sudo, fixed minor format flaw in build_docs.sh.
This commit is contained in:
parent
c282cf4ea7
commit
616724271c
|
@ -3,7 +3,7 @@
|
|||
filename=Manual
|
||||
doc_files=(
|
||||
'Introduction.md'
|
||||
'Getting Started.md'
|
||||
'Getting Started.md'
|
||||
'Safety.md'
|
||||
'Installation.md'
|
||||
'Configuration.md'
|
||||
|
|
|
@ -1,12 +1,12 @@
|
|||
#Building Manual.
|
||||
|
||||
The manual PDF file is generated by concatenating relevant markdown files and by transforming the result using Gimli to obtain the final PDF file. This steps are handled automatically by the ```build_manual.sh``` script located in the root of the repository next to the Makefile.
|
||||
The manual PDF file is generated by concatenating relevant markdown files and by transforming the result using Gimli to obtain the final PDF file. This steps are handled automatically by the ```build_docs.sh``` script located in the root of the repository next to the Makefile.
|
||||
|
||||
##Requrements & Installation
|
||||
The PDF manual generation uses the Gimli for the conversion. It can be installed via ruby gems. On Debian based systems the installation steps are:
|
||||
```bash
|
||||
sudo apt-get install ruby1.9.1 ruby1.9.1-dev rubygems zlib1g-dev wkhtmltopdf libxml2-dev libxslt-dev
|
||||
sudo sudo gem1.9.1 install gimli
|
||||
sudo gem1.9.1 install gimli
|
||||
```
|
||||
|
||||
##Configuration
|
||||
|
@ -17,4 +17,4 @@ doc_files=( 'Configuration.md'
|
|||
'...'
|
||||
'...'
|
||||
)
|
||||
```
|
||||
```
|
||||
|
|
Loading…
Reference in New Issue