Add instructions for building locally

This commit is contained in:
Tony Grosinger 2024-06-05 20:12:10 -07:00
parent cb75a136dd
commit 5ec0b5e18a

36
tgrosinger-readme.md Normal file
View File

@ -0,0 +1,36 @@
# Instructions for building
1. Install devcontainer cli
```sh
brew install devcontainer
```
2. Setup the devcontainer
```sh
devcontainer up --workspace-path . --docker-path $(which podman)
```
3. Initialize west (this takes a while)
```sh
devcontainer exec --workspace-path . --docker-path $(which podman)
west init -l app/
west update
```
4. Build the firmware
```sh
cd app
west build --pristine -b nice_nano_v2 -- -DSHIELD=chrysemys
```
5. Copy the uf2 file onto the root of the USB mass storage for the keyboard. The uf2 file can be found at `app/build/zephyr/zmk.uf2`.
## Documentation
- [Docker setup](https://zmk.dev/docs/development/setup/docker)
- [Building](https://zmk.dev/docs/development/build-flash)