https://github.com/rschenk/zmk-keyboard-egret
ZMK Module for Egret keyboard
https://github.com/rschenk/zmk-keyboard-egret
zmk zmk-module
Last synced: 5 months ago
JSON representation
ZMK Module for Egret keyboard
- Host: GitHub
- URL: https://github.com/rschenk/zmk-keyboard-egret
- Owner: rschenk
- Created: 2025-04-24T17:58:38.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-24T18:18:06.000Z (about 1 year ago)
- Last Synced: 2025-04-24T19:29:49.857Z (about 1 year ago)
- Topics: zmk, zmk-module
- Homepage:
- Size: 6.84 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Egret ZMK Module
This is a [ZMK Module](https://zmk.dev/docs/features/modules) for my [Egret keyboard](https://github.com/rschenk/egret).
To use this in your zmk-config, follow the [ZMK Module docs](https://zmk.dev/docs/features/modules) using the config below. You'll name your keymap `egret.keymap`.
## Usage
Add the following entries to `remotes` and `projects` in `config/west.yml`
```yaml
# config/west.yml
manifest:
remotes:
- name: zmkfirmware
url-base: https://github.com/zmkfirmware
- name: rschenk
url-base: https://github.com/rschenk
projects:
- name: zmk
remote: zmkfirmware
import: app/west.yml
- name: zmk-keyboard-egret
remote: rschenk
revision: main
self:
path: config
```
And then in your `build.yaml` file:
```yaml
# build.yaml
board: ["nice_nano_v2"]
shield: ["egret"]
```