Skip to content

Commit

Permalink
Add a shields readme
Browse files Browse the repository at this point in the history
  • Loading branch information
caksoylar committed Apr 3, 2024
1 parent a549ee6 commit a8c80db
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions boards/shields/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
## Custom shields

This repo also contains shield definitions for a few keyboards. Ones using Pro Micro format daughterboards:

- [`choc_ergo`](https://keypcb.xyz/choc_ergo)
- [`hypergolic`](https://github.com/davidphilipbarr/hypergolic) -- you should probably use [the official Cradio shield](https://github.com/zmkfirmware/zmk/tree/main/app/boards/shields/cradio/) instead
- [`ffkb` v1](https://fingerpunch.xyz/product/faux-fox-keyboard/) with an OLED, building upon [sadekbaroudi's](https://github.com/sadekbaroudi/zmk-ffkb) and [NCKiser's](https://github.com/NCKiser/zmk-ffkb) definitions
- [`swweeep`](https://github.com/sadekbaroudi/sweep36) using [sadekbaroudi's](https://github.com/sadekbaroudi/zmk-swweeep) definition

Ones using Seeeduino Xiao format daughterboards:

- [`rommana`](https://github.com/AlaaSaadAbdo/rommana): A hand-wired keywell keyboard with 28 keys, using Xiao BLEs
- [`grumpybird`](https://github.com/caksoylar/Grumpy/tree/hummingbird-pinky): A hand-wired variant of the [Grumpy](https://github.com/weteor/Grumpy) keyboard, where upper pinky rather than lower pinky is used

0 comments on commit a8c80db

Please sign in to comment.