Jacob/zmk
1
0
Fork 0
forked from kofal.net/zmk
Code Pull Requests Activity

update doc for new shield in user repo

Browse Source
This commit is contained in:
Chiyuan Zhang
2020-11-01 13:22:34 -08:00
committed by Pete Johanson
parent 82a5736d08
commit e7cb863a41
3 changed files with 35 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/docs/user-setup.md
View File

@@ -33,6 +33,12 @@ Following the steps in this guide, you will:
1. Update the configuration flags for your user config, to enable/disable any ZMK features you would like to include.
1. Commit and push the updates to trigger a new GitHub Action run.
:::note
If you are building firmware for a new keyboard shield that is not included in the built-in
list of shields, you can choose any shield from the list that is similar to yours to generate the repository,
and edit / add necessary files according to the [guide for adding new keyboard shield](./dev-guide-new-shield.md).
:::
## Prerequisites
The remainder of this guide assumes the following prerequisites: