Changes between Version 6 and Version 7 of UserManual


Ignore:
Timestamp:
Mar 19, 2011, 10:59:31 PM (9 years ago)
Author:
nschle85
Comment:

added first version of how to build manuals

Legend:

Unmodified
Added
Removed
Modified
  • UserManual

    v6 v7  
    2020 * [http://norman-schleicher.de/jenkins/job/shr-manual/ws/shr-docs/docbook/OUTPUT/manual-freerunner/html_manual_freerunner_webhelp.zip "html_manual_freerunner_webhelp.zip"]
    2121 * [http://norman-schleicher.de/jenkins/job/shr-manual/ws/shr-docs/docbook/OUTPUT/manual-n900/html_manual_n900_webhelp.zip "html_manual_n900_webhelp.zip"]
     22
     23== Build the manuals yourself ==
     24This chapter describes how to build the SHR User Manuals.
     25=== Prerequesites ===
     26To build the manuals you need
     27 * a GIT client
     28 * Java 6 SDK
     29 * ANT
     30installed on you build system. The build system is platform independent (as Java 6 is)  so builds can be performed under different operating systems (like  GNU/Linux, MAC OS) or under Windows. 
     31
     32=== Get the sources of the manual ===
     33{{{
     34mkdir GIT-SHR-DOCS
     35cd GIT-SHR-DOCS
     36git clone http://git.shr-project.org/repo/shr-docs.git
     37}}}
     38If you already got the sources, an update is made by:
     39{{{
     40git pull
     41}}}
     42
     43=== Extract the build toolchain ===
     44This must be done only once for the first time or if the toolchain changes.
     45{{{
     46cd shr-docs/docbook/external
     47ant
     48}}}
     49The toolchain can be removed with this command in external directory:
     50{{{
     51ant clean
     52}}}
     53
     54=== Now build the manuals ===
     55leave the external directory, so your working directory will be shr-docs/docbook and start building the manuals
     56{{{
     57cd ..
     58ant
     59}}}
     60The generated manuals can be found in OUTPUT.
     61