Welcome to the Basement recipes’s documentation!

This basement project is a collection of foundational recipes and classes that can be included by other projects. Most importantly, it provides ready to use classes to handle common build systems and other recurring tasks. Additionally, a sandbox and common GCC toolchains are ready-to-use.

Contents:

• Introduction
  • Prerequisites
  • Layer architecture
  • Examples
• Usage notes
  • Basic setup
  • C/C++ toolchains
  • Standard build systems
  • Python 3
  • Perl
  • Ocaml / opam / dune
  • Rust
  • Available development tools
• Contribution guide
  • Before you start
  • Anatomy of a recipe
  • Recipe style guide
  • Class style guide
  • Recipe naming

Copyright

This documentation is part of the Basement recipes.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Indices and tables

• Index

• Search Page