diff options
| author | KingCoinless <33333456+KingCoinless@users.noreply.github.com> | 2021-01-05 10:56:47 -0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-01-05 18:56:47 +0000 |
| commit | 5c11962d986753d5da9244cf572242f43f4d126c (patch) | |
| tree | c3cfdc32a54839c70d4820f78e83124333846d60 /app/boards/shields/helix/README.md | |
| parent | a4703537603d1ae7f5a904fc57d61af7382b6f9f (diff) | |
feat(shields): add helix shield
PR: #429
Diffstat (limited to 'app/boards/shields/helix/README.md')
| -rw-r--r-- | app/boards/shields/helix/README.md | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/app/boards/shields/helix/README.md b/app/boards/shields/helix/README.md new file mode 100644 index 0000000..f8b0e13 --- /dev/null +++ b/app/boards/shields/helix/README.md @@ -0,0 +1,12 @@ +#### Note to user: + +- If desired, RGB underglow must be manually enabled before building and flashing. Check 'helix.conf' to do so. +- Peripheral RGB function is impaired until full support is implemented in the master branch. +- OLED displays are not currently included in this shield. This will be updated after OLED support is live. +- 'KANA' and 'EISUU' input is currently utilized under the 'LANG1' and 'LANG2' keycodes respectively. + +--- + +Thanks to Nicell, KemoNine, petejohanson, TJ "Chormbo The Great", joelspadin/Rinh, Wofiel, Okke, innovaker, +and the rest of the ZMK contributors for their support in constructing this shield. I appreciate your assistance greatly. +This has been a valuable learning experience for me. May this contribution serve the community well. |