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

fix(docs): Change user-setup.md order to agree with order in setup script

Browse source 
Fixes #1281 

Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
This commit is contained in:
pixls 2023-06-10 20:49:30 -04:00 • committed by GitHub
parent 98524a9567
commit 9d39a87f67
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 26 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -88,36 +88,41 @@ powershell -Command "iex ((New-Object System.Net.WebClient).DownloadString('http
</TabItem>
</Tabs>
### Keyboard Selection
When prompted, enter the number for the corresponding keyboard you would like to target:
```
Keyboard Selection:
1) 2% Milk 19) Ferris 0.2 37) Nibble
2) A. Dux 20) Fourier Rev. 1 38) nice!60
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:
```
:::note For a keyboard not in the included list:
If you are building firmware for a new keyboard that is not included in the built-in
list of keyboards, you can choose any keyboard from the list that is similar to yours (e.g. in terms of unibody/split and [onboard controller](hardware.mdx#onboard)/[composite](hardware.mdx#composite)) to generate the repository,
and edit / add necessary files. You can follow the [new shield guide](development/new-shield.md) if you are adding support for a composite keyboard.
:::
### MCU Board Selection
If the keyboard selected uses an onboard controller you will skip this step.
When prompted, enter the number for the corresponding MCU board you would like to target:
```
MCU Board Selection:
1) nice!nano
2) QMK Proton-C
3) Quit
1) BlueMicro840 v1 5) nRF52840 M.2 Module 9) QMK Proton-C
2) Mikoto 5.20 6) nRFMicro 1.1 (flipped) 10) Seeeduino XIAO
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:
```
### Keyboard Shield Selection
:::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](development/new-shield.md).
:::
When prompted, enter the number for the corresponding keyboard shield you would like to target:
```
Keyboard Shield Selection:
1) Kyria
2) Lily58
3) Quit
Pick an keyboard:
```
### Keymap Customization
At the next prompt, you have an opportunity to decide if you want the stock keymap file copied in