Commit a2450a49 authored by Dirk Brömmel's avatar Dirk Brömmel
Browse files

Update README.md

parent 1862b019
# LaTeX package for a PRACE whitepaper
(c) CSC - IT Center for Science Ltd.
author: Martti Louhivuori (martti.louhivuori@csc.fi)
original author: Martti Louhivuori (martti.louhivuori@csc.fi)
(c) JSC/PRACE
Dirk Broemmel (prace-pmo@fz-juelich.de)
Please report any problems with this template to `prace-pmo@fz-juelich.de` or contribute directly to this repository.
## PURPOSE
Enable the writing of a PRACE-RI project report in LaTeX with minimal typographical effort. Uses a pre-defined document class 'prace' that automatically sets the correct document style and layout as well as provides custom macros for the ease-of-use of the writer.
Enable the writing of a PRACE project report in LaTeX with minimal typographical effort. Uses a pre-defined document class 'prace' that automatically sets the correct document style and layout as well as provides custom macros for the ease-of-use of the writer.
## FILES
`prace.cls` : LaTeX document class
`template.tex` : PRACE-RI whitepaper template
`prace-logo.png`, `prace-logo.eps` : logo of PRACE (used by prace.cls)
`template.tex` : PRACE whitepaper template
`prace-logo.[pdf|eps|png]` : logo of PRACE (used by prace.cls)
The `example` directory contains a full example:
`example.tex` : example of a filled-in template
`example.pdf` : example PRACE-RI whitepaper
`example.png`, `example.eps` : figure used in the example whitepaper
`example.pdf` : example PRACE whitepaper
`example.[eps|png]` : figure used in the example whitepaper
## REQUIREMENTS
Some LaTeX packages are assumed to be present for this class to work: `mathptmx` (for the correct font), `siunitx` (for properly formatted numbers+units), and `fancyhdr` (which should be updated at some point).
The current version of the template is meant for use with `latex` or `pdflatex`, a modern dialect may follow in the future.
## QUICK HOW-TO
1) copy `template.tex` to `yourname_yourproject.tex`
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment