diff --git a/build_docs.sh b/build_docs.sh new file mode 100755 index 0000000000..bfab4d34ed --- /dev/null +++ b/build_docs.sh @@ -0,0 +1,44 @@ +#!/bin/bash + +filename=Manual +doc_files=( 'Configuration.md' + 'Board - CC3D.md' + 'Board - Naze32.md' + 'Rx.md' + 'Serial.md' + 'Failsafe.md' + 'Battery.md' + 'Gps.md' + 'Rssi.md' + 'Telemetry.md' + 'LedStrip.md' + 'Display.md' + 'Buzzer.md' + 'Sonar.md' + 'Autotune.md' + 'Migrating from baseflight.md') + +if which gimli >/dev/null; then + echo "Building ${filename}.pdf" + pushd . >/dev/null + cd docs + + rm -f ${filename}.md + for i in "${doc_files[@]}" + do + cat "$i" >> ${filename}.md + done + rm -f ${filename}.pdf + gimli -f ${filename}.md + rm ${filename}.md + popd >/dev/null +else + echo -e "\nFAILED" + echo "Install Gimli to build the PDF documentation" + echo -e "https://github.com/walle/gimli\n" + exit 1 +fi + + + + diff --git a/docs/Display.md b/docs/Display.md old mode 100644 new mode 100755 index 959a2aaab4..9dc9ade6da --- a/docs/Display.md +++ b/docs/Display.md @@ -60,10 +60,13 @@ or other display corruption. More can be read about this procedure here: http://www.multiwii.com/forum/viewtopic.php?f=6&t=2705&start=10 -There are diagrams in the Wiring directory. +![Crius CO-16 Diagram](Wiring/Crius CO-16 OLED diagram.png) +![Crius CO-16 Modification](Wiring/Crius CO-16 OLED modifications.jpg) ## Connections Connect +5v, Ground, I2C SDA and I2C SCL from the flight controller to the display. On Naze32 rev 5 boards the SDA and SCL pins are underneath the board. + + diff --git a/docs/Wiring/Crius CO-16 OLED diagram.jpg b/docs/Wiring/Crius CO-16 OLED diagram.jpg deleted file mode 100644 index 6ed6c00f52..0000000000 Binary files a/docs/Wiring/Crius CO-16 OLED diagram.jpg and /dev/null differ diff --git a/docs/Wiring/Crius CO-16 OLED diagram.png b/docs/Wiring/Crius CO-16 OLED diagram.png new file mode 100755 index 0000000000..cbac77a9f9 Binary files /dev/null and b/docs/Wiring/Crius CO-16 OLED diagram.png differ diff --git a/docs/Wiring/Crius CO-16 OLED modifications.jpg b/docs/Wiring/Crius CO-16 OLED modifications.jpg old mode 100644 new mode 100755 index d5a9e72be2..8869a80b64 Binary files a/docs/Wiring/Crius CO-16 OLED modifications.jpg and b/docs/Wiring/Crius CO-16 OLED modifications.jpg differ diff --git a/docs/development/Building Manual.md b/docs/development/Building Manual.md new file mode 100755 index 0000000000..cb9497b65d --- /dev/null +++ b/docs/development/Building Manual.md @@ -0,0 +1,23 @@ +#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: +```bash + sudo aptitude install rubygems wkhtmltopdf libxml2-dev libxslt-dev + sudo gem1.8 install gimli +``` + +##Configuration +All markdown files need to be registered in the ```build_manual.sh``` file individually by modifying the ```doc_files``` variable / array: +```bash +doc_files=( 'Configuration.md' + 'Board - CC3D.md' + '...' + '...' +) +``` + +##Restritions +As the conversion via Gimli will not respect embedded image's DPI settings, the diemnsions of the image will be defined by the physical resolution in pixels. As a rule of thumb one should not embedd images wider than 600px in the markdown files. \ No newline at end of file diff --git a/docs/Building in Windows.md b/docs/development/Building in Windows.md old mode 100644 new mode 100755 similarity index 100% rename from docs/Building in Windows.md rename to docs/development/Building in Windows.md diff --git a/docs/Development.md b/docs/development/Development.md old mode 100644 new mode 100755 similarity index 100% rename from docs/Development.md rename to docs/development/Development.md