2024-06-05 20:12:10 -07:00
|
|
|
# ZMK
|
2020-05-01 16:49:04 -04:00
|
|
|
|
2024-06-05 20:12:10 -07:00
|
|
|
NOTE: Try to keep the repo up to date as much as possible. Pull from the
|
|
|
|
|
upstream master and then rebase my branch on top of it.
|
2020-05-25 21:39:44 -04:00
|
|
|
|
2024-06-05 20:12:10 -07:00
|
|
|
## Instructions for building
|
2020-05-01 16:49:04 -04:00
|
|
|
|
2024-06-05 20:12:10 -07:00
|
|
|
1. Install devcontainer cli
|
2020-05-27 10:42:35 -04:00
|
|
|
|
2024-06-05 20:12:10 -07:00
|
|
|
```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)
|
2020-07-03 10:51:29 -04:00
|
|
|
|
