Skip to content

Latest commit

 

History

History
75 lines (48 loc) · 2.33 KB

README.md

File metadata and controls

75 lines (48 loc) · 2.33 KB
Raw

Jackal User Manual

This repository contains the LaTeX source code for building the end user product documentation for Jackal. If you are an end user, please download the official and released version of the manual from the Clearpath Robotics Resources Page.

Build

To build Jackal's user manual:

git clone --recurse-submodules https://github.com/jackal/jackal-user-manual.git
cd jackal-user-manual
xelatex jackal.tex

The output is written to jackal.pdf. The xelatex command must be invoked twice to generate the complete manual including table of contents and correct watermarks.

Setting it up

The manual may be built on any platform supported by TeXWorks or TeXLive.

On a Mac, download and install MacTex Basic.

On Ubuntu, run:

sudo apt-get install texlive-xetex

Install some additional texlive packages:

sudo tlmgr install everypage background titlesec microtype upquote \
                   enumitem tcolorbox environ trimspaces siunitx

On Windows:

  • Install TeXworks.
  • Install Source Tree, or your preferred Windows Git client.
  • Install DINPro, Consolas typefaces.
  • Use Sourcetree to clone this repo locally, then open jackal.tex in TeXworks.
  • In Texworks, in the drop down menu beside the green arrow, switch to XeLaTeX + MakeIndex + BibTex
  • Click the green start arrow

Typefaces

To build the official manual, the following fonts will need to be installed:

Visuals

The visual components including diagrams and cover page are SVG documents created using Inkscape. Download this for your platform to edit these components. When you are ready to integrate the edited component into the manual, you must export it to a PDF in the gen folder.

For the cover page:

  • Full page output, including text.

For diagrams and illustrations:

  • Exclude text, also render LaTeX.

License

Redistribution and use in source and binary forms, with or without modification, is not permitted without the express permission of Clearpath Robotics.