kb01/zmk
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fix: update user-setup to more accurately reflect the current setup script flow

Browse source
This commit is contained in:
pixls 2022-07-29 18:30:35 -04:00
parent 745f0f9ac2
commit c5f2b3f008
1 changed files with 17 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
docs/docs/user-setup.md
View file

@ -88,33 +88,39 @@ powershell -Command "iex ((New-Object System.Net.WebClient).DownloadString('http
</TabItem> </TabItem>
</Tabs> </Tabs>
### Keyboard Shield Selection ### Keyboard Selection
:::note :::note
If you are building firmware for a new keyboard shield that is not included in the built-in If you are building firmware for a new keyboard or 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, list of keyboards, you can choose any keyboard or 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](development/new-shield.md). and edit / add necessary files according to the [guide for adding new keyboard shield](development/new-shield.md).
::: :::
When prompted, enter the number for the corresponding keyboard shield you would like to target: When prompted, enter the number for the corresponding keyboard you would like to target:
``` ```
Keyboard Shield Selection: Keyboard Selection:
1) Kyria 1) 2% Milk 19) Ferris 0.2 37) Nibble
2) Lily58 2) A. Dux 20) Fourier Rev. 1 38) nice!60
3) Quit 3) BAT43 21) Helix 39) Osprette
4) BDN9 Rev2 22) Hummingbird 40) Pancake
5) BFO-9000 23) Iris 41) Planck Rev6
6) Boardsource 3x4 Macropad 24) etc...
Pick an keyboard: Pick an keyboard:
``` ```
If the keyboard selected uses an onboard controller you will skip the MCU Board selection step.
### MCU Board Selection ### MCU Board Selection
When prompted, enter the number for the corresponding MCU board you would like to target: When prompted, enter the number for the corresponding MCU board you would like to target:
``` ```
MCU Board Selection: MCU Board Selection:
1) nice!nano 1) BlueMicro840 v1 5) nRF52840 M.2 Module 9) QMK Proton-C
2) QMK Proton-C 2) Mikoto 5.20 6) nRFMicro 1.1 (flipped) 10) Seeeduino XIAO
3) Quit 3) nice!nano v1 7) nRFMicro 1.1/1.2 11) Seeeduino XIAO BLE
4) nice!nano v2 8) nRFMicro 1.3/1.4 12) Quit
Pick an MCU board: Pick an MCU board:
``` ```