Skip to content

Commit

Permalink
docs: use nice_nano_v2 for board-specific shield config example
Browse files Browse the repository at this point in the history
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
  • Loading branch information
lesshonor and caksoylar authored Sep 27, 2024
1 parent 07c8444 commit 504f81e
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/docs/features/underglow.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ Support for RGB underglow is always added to a board, not a shield. This is beca

Shields written for boards which support RGB underglow should add a `boards/` folder underneath the shield folder. Inside this `boards/` folder, create a `<board>.overlay` for any of the boards the shield can be used with. Place all hardware-specific configurations in these `.overlay` files.

For example: the `kyria` shield has a [`boards/nice_nano.overlay`](https://github.com/zmkfirmware/zmk/blob/main/app/boards/shields/kyria/boards/nice_nano.overlay) and a [`boards/nrfmicro_13.overlay`](https://github.com/zmkfirmware/zmk/blob/main/app/boards/shields/kyria/boards/nrfmicro_13.overlay), which configure a WS2812 LED strip for the `nice_nano` and `nrfmicro_13` boards respectively.
For example: the `kyria` shield has a [`boards/nice_nano_v2.overlay`](https://github.com/zmkfirmware/zmk/blob/main/app/boards/shields/kyria/boards/nice_nano_v2.overlay) and a [`boards/nrfmicro_13.overlay`](https://github.com/zmkfirmware/zmk/blob/main/app/boards/shields/kyria/boards/nrfmicro_13.overlay), which configure a WS2812 LED strip for the `nice_nano_v2` and `nrfmicro_13` boards respectively.

### nRF52-Based Boards

Expand Down

0 comments on commit 504f81e

Please sign in to comment.