icotronic 3.0.0a2

Control and test software for sensory tool holders (STH), sensor milling heads (SMH) and stationary transceiver units (STU)

ICOtronic

This repository contains data collection and test software for the ICOtronic system. For more information, please take a look at the online documentation.

Documentation

While you should be able to read the various Markdown files of the documentation separately, we recommend you read the bookdown manual instead. We provide a prebuilt version of the documentation here.

You can also download the documentation under the GitHub Actions tab (just select the latest run and click on the link “ICOtronic Manual”).

Build

If you want to build the documentation yourself, you need the following software:

• R,
• bookdown,
• make, and
• (optionally for the PDF version of the manual) the TinyTeX R package.

After you installed the required software you can build the

• HTML (make html),
• EPUB (make epub), and
• PDF (make pdf)

version of the documentation. The output will be stored in the folder Bookdown in the root of the repository. If you want to build all versions of the documentation, just use the command

make doc

in the repo root.