Skip to content

pacman-project/pacman-reports

Repository files navigation

pacman-reports

Installing the report style

The reports use the style defined in the file templates/pacamanreport.cls. You need to install it on your tex system in order to compile the reports following these instructions.

Note: the steps should be repeated if the file is changed.

Dependencies:

  1. bibliography uses the IEEEtran style, so ensure you have it on your system. In Linux: sudo apt-get install texlive-publishers.
  2. Some reports use stuff from texlive-science. In Linux: sudo apt-get install texlive-science

On Windows/TeXLive:

Just copy the .cls file into the local texmf folder. In my laptop I just copied this is in: C:\texlive\texmf-local\tex\latex\local

On Unix-based (at least Ubuntu 14.04):

sudo rsync -a ./templates/pacmanreport.cls /usr/share/texmf/tex/latex/pacmanreport/

sudo texhash

On Windows/MikTeX:

  • Add the path to the templates folder using the admin menu of MikTeX:

Image of MikTeX/Roots

  • Refresh the MikTeX database:

Image of MikTeX/General

Adding a new document

  • Create your folder DRXY/MSXY containing your DRXY/MSXY.tex, and also bibliography, images, as subfolders. We encourage the use of \graphicspath{} to access shared_images.

For CMakers:

  • Add a CMakeLists.txt following this template, and filling convieniently the options:
project(DRXY)
cmake_minimum_required(VERSION 2.8)

ADD_LATEX_DOCUMENT(DRXY.tex
                   [BIBFILES <bib_files>]
                   [IMAGE_DIRS] image ../shared_images
                   )
  • Add your folder to the main CMakeLists.txt with add_subdirectory(DRXY)

Build

For CMakers:

  • Type mkdir build && cd build && cmake ..

  • Type make and use tab completion. Or hit make / make all to compile all reports at once, or hit make DRXY or make MSXY to compile a specific report.

All PDFs are copied into the pdf folder to access them easily.

Note: The make clean command is not implemented, you need to delete auxiliary files by hand. Or you can clean the output of a single report make DRXY_clean or make MSXY_clean.