tgrosinger/zmk
1
0
Fork 0
Code Actions Packages

tweak doc according to PR feedback

Browse Source
This commit is contained in:
Chiyuan Zhang 2020-11-01 14:21:40 -08:00 committed by Pete Johanson
parent e7cb863a41
commit 9b941b7509
3 changed files with 14 additions and 14 deletions

2
docs/docs/dev-guide-new-shield.md

@ -32,7 +32,7 @@ This guide describes how to add shield to the ZMK main repository. If you are bu
own prototype or handwired keyboard, it is recommended to use your own user config repository. Follow the
[user setup guide](./user-setup.md) to create your user config repository first. When following the rest
of this guide, replace the `app/` directory in the ZMK main repository with the `config/` directory in your
user config repository. Form example, `app/boards/shields/<keyboard_name>` should now be
user config repository. For example, `app/boards/shields/<keyboard_name>` should now be
`config/boards/shields/<keyboard_name>`.
:::

14
docs/docs/dev-guide-usb-logging.md

@ -24,6 +24,13 @@ It is recommended to only enable logging when needed, and not leaving it on by d
The following KConfig values need to be set, either by copy and pasting into the `app/prj.conf` file, or by running
`west build -t menuconfig` and manually enabling the various settings in that UI.
:::note
If you are debugging your own keyboard in your [user config repository](./user-setup.md), use
`config/boards/shields/<your_keyboard>/<your_keyboard>.conf` instead of `app/prj.conf`. In Github
Actions, you can search the `Kconfig file` build log to verify the options above have been enabled
for you successfully.
:::
```
# Turn on logging, and set ZMK logging to debug output
CONFIG_LOG=y
@ -50,13 +57,6 @@ CONFIG_UART_CONSOLE_ON_DEV_NAME="CDC_ACM_0"
CONFIG_USB_UART_DTR_WAIT=n
```
:::note
If you are debugging your own keyboard in your [user config repository](./user-setup.md), use
`config/boards/shields/<your_keyboard>/<your_keyboard>.conf` instead of `app/prj.conf`. In Github
Actions, you can search the `Kconfig file` build log to verify the options above have been enabled
for you successfully.
:::
## Viewing Logs
After flashing the updated ZMK image, the board should expose a USB CDC ACM device that you can connect to and view the logs.

12
docs/docs/user-setup.md

@ -33,12 +33,6 @@ 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:
@ -109,6 +103,12 @@ 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](./dev-guide-new-shield.md).
:::
When prompted, enter the number for the corresponding keyboard shield you would like to target:
```