Skip to content

Expand Readme #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
j-medland wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Expand Readme #6

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9472f79
Enhance README with release link and video
j-medland Jan 31, 2026
4bc6cd2
Give documentation link its own heading
j-medland Jan 31, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 15 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,21 @@
# cti-firmware
Microcontroller firmware with simulation modes

[Documentation](./docs/readme.md)
> [!TIP]
> You can download the pre-built firmware from the [Github Releases Page](../../releases/latest)
>
> Expand the "Assets" under a release to obtain the `.uf2` file

## Documentation

Checkout the documentation for the firmware [here](./docs/readme.md).

## Building

The CTI firmware is designed to handle a myriad of target devices and toolchains. As such, a build needs to be run for a specific platform and optionally for a specific board. Optionally, firmware for a specific operating mode can be built so look in the readme for a specific platform for available options and boards.
The CTI firmware is designed to handle a myriad of target devices and toolchains. As such, a build needs to be run for a specific platform and optionally for a specific board. Optionally, firmware for a specific operating mode can be built so look in the readme for a specific platform for available options and boards.

### Setting & Build (Windows)

Norm Kirchner has created a video to guide you through the setup and build process

[![Norm Kirchner on YouTube "Building Firmware for Pico RP2040 for the LabVIEW Community Training Initiative CTI"](https://img.youtube.com/vi/3A7etm1dq8Q/0.jpg)](https://www.youtube.com/watch?v=3A7etm1dq8Q)