Skip to content

cronologic-de/ug_timetagger4

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

63 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ug_timetagger4

HTML/PDF User Guide for the cronologic TimeTagger4 time-to-digital converter.

This is a Sphinx project that creates the User Guide for the TimeTagger4, time-to-digital converter (TDC) from cronologic GmbH & Co. KG.

Find the documentation online at docs.cronologic.de/timetagger4.

Prerequisites

Python is necessary for creating the HTML output.

Python and LuaLaTeX are necessary for creating the LaTeX/PDF output.

Dependencies are managed using uv.

Fonts for LaTeX

The fontspec package is used for the LaTeX output. It may complain that fonts are missing from your system.

The following fonts are required for the LaTeX output and are included in the listed packages.

  • Montserrat (main font): montserrat
  • TeX Gyre Adventor (headings font): tex-gyre
  • Latin Modern Math (math font): lm-math
  • Latin Modern Mono Light (monospaced font): lm
  • KerkisSans (expanded Greek letters): kerkis

Building

Run

make html

or

make latexpdf

to compile the project as HTML or PDF. The HTML (PDF) output is in build/html/ (build/latex/).

Alternatively, if you do not have make, use the make.bat script instead.

License

Creative Commons by-nd 4.0

This documentation is licensed under the CC BY-ND 4.0 license. You are free to copy and redistribute the material in any medium or format for any purpose, even commercially unchanged if you give appropriate credit to cronologic GmbH & Co. KG. A link to this repository or the product page is sufficient. If you decide to contribute to this repository, you transfer non-exclusive but unlimited rights to your edit to cronologic GmbH & Co. KG.

The file extraplaceins.sty is in the public domain.