Reference

This section contains reference documentation for Toolkit. It is meant to be comprehensive and detailed, covering all the features and components, but may not be the best place to start for new users.

The concepts and design decisions of Toolkit are explained in the Explanations section.

To get started, please refer to the Tutorials section. For practical instructions, see the How-To Guides section.

Scripts

The scripts provided by Toolkit are command-line tools designed to integrate well into build systems or other workflows: If an error occurs, they return a non-zero exit code and do not produce partial output. Optionally, they can also produce a dependency file in the format used by gcc, to allow for proper incremental builds.

fast-ninja rules are also provided for all scripts, which are documented in the reference for each script.

Python Classes

These classes are the building blocks of the scripts provided by Toolkit. They can also be used independently to create your own tools and scripts.

They cover a wide range of functionality useful in cross development for retro computers like image conversion, assembler source creation, file handling, message reporting, and command line interface.