Documentation

Building and Developing

• A quick start guide to building a demo application and controller is available in the Getting started guide
• A guide to new cluster and device type development is available in the New Cluster and Device Type Developement Guide
• Documentation about building from the command line can be found in the build guide
• Documentation about running cirque tests can be found in the cirque test guide
• Documentation about standard build & development flows using Visual Studio Code can be found in the development guide

Platform Guides

• Various guides are available here that cover platform bring up, testing, and various troubleshooting things.

Project Flow

• Documentation about general project usage of GitHub, and project tools is documented in the project flow

Style Guide

• Documentation about style is documented in the style guide
• Additional documentation about more specific files are in the style folder

Third Party Tools

Some tools and utilities are dependent on third party tools, such as Docker.

Docker is an excellent way to have stable build environments that don't pollute the host OS. It is also much easier to maintain stability across multiple host environments. Install stable version of Docker Desktop relevant to your native OS (macOS or Windows). Once installed, you can run docker commands from the shell/terminal.