diff options
Diffstat (limited to 'doc/map-viewer/tools/README.txt')
-rwxr-xr-x | doc/map-viewer/tools/README.txt | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/doc/map-viewer/tools/README.txt b/doc/map-viewer/tools/README.txt new file mode 100755 index 0000000..24e2eb2 --- /dev/null +++ b/doc/map-viewer/tools/README.txt @@ -0,0 +1,27 @@ +--------------------------------- +Document Generation +--------------------------------- + +0) +Install the following packages: +sudo apt-get install wkhtmltopdf +sudo apt-get install xsltproc +sudo apt-get install pdftk + +1) +Modify the <component name>API-part1.doc as needed. + +2) +Convert the <component name>API-part1.doc +into a pdf document with the same name. + +3) +Navigate to the directory 'tools'. + +4) +Generate the documentation: +./generate-doc.sh + +A document called <component name>API-part2.pdf will be automatically generated. +The final component documentation (<component name>API.pdf) will be created in +the parent directory. |