wiki:UserManual

Version 8 (modified by nschle85, 9 years ago) (diff)

--

The SHR User Manual

This page describes where to find pre build versions of SHR User Manual and how to build it yourself.

Download or browse pre build manuals

Pre build manuals are generated on a Jenkins build host.

Download a PDF version

The generated PDF manuals are (will be) available for different devices. Here are the links:

Browse a html version

The generated html manuals are (will be) available for different devices. Here are the links:

Download a ziped html version

The ziped html manuals are (will be) available for different devices. Here are the links:

Build the manuals yourself

This chapter describes how to build the SHR User Manuals.

Prerequesites

To build the manuals you need

  • a GIT client
  • Java 6 SDK
  • ANT

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

Get the sources of the manual

mkdir GIT-SHR-DOCS
cd GIT-SHR-DOCS
git clone http://git.shr-project.org/repo/shr-docs.git

If you already got the sources, an update is made by:

git pull

Extract the build toolchain

This must be done only once for the first time or if the toolchain changes.

cd shr-docs/docbook/external
ant

The toolchain can be removed with this command in external directory(only necessary on update problems, please do not remove the toolchain if you want to compile the manual):

ant clean

Now build the manuals

leave the external directory, so your working directory will be shr-docs/docbook and start building the manuals

cd ..
ant

The generated manuals can be found in OUTPUT.