Skip to content

Update readme.md #3052

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

Merged
beastoin merged 1 commit into from
Sep 26, 2025
Merged

Update readme.md #3052

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
24 changes: 1 addition & 23 deletions omi/firmware/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,32 +22,10 @@ The Omi firmware is built on the Zephyr RTOS and provides functionality for audi
- `boards/`: Custom board definitions and configurations
- `scripts/`: Build and utility scripts

## Building the Firmware

There are two ways to build the firmware:

### Option 1: Using nRF Connect for VS Code
## Building and flashing the Firmware

Follow the instructions in our [official documentation](https://docs.omi.me/doc/developer/firmware/Compile_firmware).

### Option 2: Using Docker

This is the easiest method and works across all platforms:

```bash
./scripts/build-docker.sh
```

For detailed instructions, see [docker-build.md](./scripts/docker-build.md).


## Flashing the Firmware

Follow the instructions at https://docs.omi.me/doc/get_started/Flash_device

For Docker builds, the output files will be in `build/docker_build/`.
For nRF Connect builds, locate the `zephyr.uf2` file in your build output directory.

## Device-Specific Builds

For different device hardware versions (e.g., V1 and V2), use separate overlay files and project configuration files. See `CMakePresets.json` for the available configurations.
Expand Down