Skip to content

A LaTeX package for quickly writing consistent and concise publications on cable-driven parallel robots

License

Notifications You must be signed in to change notification settings

cable-robots/latex

Repository files navigation

Cable Robots - LaTeX Packages

pipeline status GitHub license GitHub release GitHub version Open Source Love png1 Maintenance made-with-latex

This is the nonofficial repository of LaTeX document classes, styles, packages, and templates for documents at the University of Stuttgart. If you are interested in just finding the most recent files you need for writing code, please refer to the releases page:

Download most recent release

Requirements

LaTeX Distribution

You need an up-to-date version of a LaTeX distribution on your current operating system. We generally advise against MikTeX, and advise for using TeXlive.

Compiler Engine

As the trend in development of LaTeX related packages and classes is to move away from pdflatex towards xelatex or lualatex, we are not providing support for pdflatex anymore. As such, you will need to compile your document using either XeLaTeX or luaLaTeX (preferably luaLaTeX, as the classes are more thoroughly tested against luaLaTeX).

Additionally, if you want to play it safe, use latexmk to build your document. Our provided .latexmkrc files include all the necessary commands to compile everything in the right order. Only requirement is access to a command line with latexmk on your path. Some LaTeX-IDEs also allow using latexmk instead of some weird lualatex + makeindex + ... + dvips combo.

PS: The developers are solely using latexmk, so support for users using latexmk will be the best.

Usage

Download a release and copy the included *.sty files into your working directory or to any path in your TEXMFHOME. If you do not know what TEXMFHOME is, then you are better off with this option. If you do know what TEXMFHOME is but do not know where it is, then run

kpsewhich --var-value TEXMFHOME

in a local shell and copy the files into directory $TEXMFHOME/tex/latex/cablerobot/ - which you have to create yourself.

You can also download the source code and run

make ins

inside a shell to install the compiled files into your TEXMFHOME directory. This option does not clutter your current working directory and you won't end up with many copies of different versions of the source file

Contributing

Before sending a pull request, be sure to check out the Contribution Guidelines first.

Development Team

Cable Robots -- LaTeX Packages was created by Philipp Tempel who both uses and continues developing the packages.