For the complete documentation index, see llms.txt. This page is also available as Markdown.

Introduction

Introduction

The Developer Cookbook is a collection of practical, high-impact recipes designed to help you extend, customize, and build on top of the OpenMind platform. If the Quickstart shows you how to use OM1, this Cookbook shows you how to build with it.

Here's what you can do with OM1

  1. Build a new config file

  2. Introduce a new mode

  3. Configure a new Input Plugin

Before building with OM1, make sure you've completed the Getting Started guide and have OM1 installed. Understand the important concepts and components that are part of OM1.

At minimum, from a fresh clone you should have run:

make deps    # download the zenoh-c library and Go module dependencies
make build   # compile the om1 binary

You can then run any agent config with make run CONFIG=<name> (or make dev CONFIG=<name> for verbose logs). Then dive into any recipe that interests you!

Development workflow

Linting and Testing (Mandatory)

Run repository checks before committing:

make check

Or run individual checks when needed:

make fmt
make lint
make test

Unit Testing

To unit test the system, run:

Use clear naming conventions and comments for better code maintainability.

Last updated

Was this helpful?