Marlin documentation

Welcome to the official Marlin framework documentation! In these pages you can find different levels of documentation.

• The reference manual (Doxygen doc)
• The user manual
• General information on the project

The source of Marlin are hosted on GitHub at https://github.com/iLCSoft/Marlin.

See "contribute" for issue tracking and pull requests.

Looking for something in particular?

Use the search engine at the top left corner of this page!

You want to install the Marlin software?

Checkout our installation procedure and dependencies.

You are new to Marlin ?

• Read the introduction.
• How to get started?

You are developing a marlin Processor ?

• The processor API
• The XML steering file doc
• The classes documentation (Doxygen)

You want to port your processor to multi-threading ?

• Introduction to MarlinMT
• Tips and tricks for thread safety