juju/cleanflight
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
cleanflight/docs/development/Building Manual.md
pulsar e6006232c8 using css overrides to restrict wide content resizing the pdf canvas 
css overrides to restrict wide content resizing the pdf canvas

pdf manual building using ruby1.9, ci integration, cosmetics.

fixed typo

debugging travis build env

upload script bugfixes, fighting ruby env

fighting ruby env

fighting ruby env

fighting ruby env
2015-04-03 18:05:48 +02:00

864 B
Executable file
Raw Permalink Blame History

#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.

##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:

    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

##Configuration All markdown files need to be registered in the build_manual.sh file individually by modifying the doc_files variable / array:

doc_files=( 'Configuration.md'
	'Board - CC3D.md'
	'...'
	'...'
)