docs: formatted with prettier
This commit is contained in:
parent
a29e041b1f
commit
978b61c4b6
3 changed files with 7 additions and 7 deletions
|
@ -28,11 +28,11 @@ ZMK support for split keyboards requires a few more files than single boards to
|
||||||
## New Shield Directory
|
## New Shield Directory
|
||||||
|
|
||||||
:::note
|
:::note
|
||||||
This guide describes how to add shield to the ZMK main repository. If you are building firmware for your
|
This guide describes how to add shield to the ZMK main repository. If you are building firmware for your
|
||||||
own prototype or handwired keyboard, it is recommended to use your own user config repository. Follow the
|
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
|
[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
|
of this guide, replace the `app/` directory in the ZMK main repository with the `config/` directory in your
|
||||||
user config repository. For 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>`.
|
`config/boards/shields/<keyboard_name>`.
|
||||||
:::
|
:::
|
||||||
|
|
||||||
|
@ -75,7 +75,7 @@ that make sense to have different defaults when this shield is used. One main it
|
||||||
that usually has a new default value set here is the `ZMK_KEYBOARD_NAME` value,
|
that usually has a new default value set here is the `ZMK_KEYBOARD_NAME` value,
|
||||||
which controls the display name of the device over USB and BLE.
|
which controls the display name of the device over USB and BLE.
|
||||||
|
|
||||||
The updated new default values should always be wrapped inside a conditional on the shield config name defined in the `Kconfig.shield` file. Here's the simplest example file.
|
The updated new default values should always be wrapped inside a conditional on the shield config name defined in the `Kconfig.shield` file. Here's the simplest example file.
|
||||||
|
|
||||||
:::warning
|
:::warning
|
||||||
Do not make the keyboard name too long, otherwise the bluetooth advertising might fail and you will not be able to find your keyboard from your laptop / tablet.
|
Do not make the keyboard name too long, otherwise the bluetooth advertising might fail and you will not be able to find your keyboard from your laptop / tablet.
|
||||||
|
|
|
@ -27,7 +27,7 @@ The following KConfig values need to be set, either by copy and pasting into the
|
||||||
:::note
|
:::note
|
||||||
If you are debugging your own keyboard in your [user config repository](./user-setup.md), use
|
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
|
`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
|
Actions, you can search the `Kconfig file` build log to verify the options above have been enabled
|
||||||
for you successfully.
|
for you successfully.
|
||||||
:::
|
:::
|
||||||
|
|
||||||
|
@ -90,14 +90,14 @@ If you already have the Ardunio IDE installed you can also use its built-in Seri
|
||||||
</TabItem>
|
</TabItem>
|
||||||
<TabItem value="macos">
|
<TabItem value="macos">
|
||||||
|
|
||||||
On MacOS, the device name is something like `/dev/tty.usbmodemXXXXX` where `XXXXX` is some numerical ID.
|
On MacOS, the device name is something like `/dev/tty.usbmodemXXXXX` where `XXXXX` is some numerical ID.
|
||||||
You can connect to the device with [tio](https://tio.github.io/) (can be installed via [Homebrew](https://formulae.brew.sh/formula/tio)):
|
You can connect to the device with [tio](https://tio.github.io/) (can be installed via [Homebrew](https://formulae.brew.sh/formula/tio)):
|
||||||
|
|
||||||
```
|
```
|
||||||
sudo tio /dev/tty.usbmodem14401
|
sudo tio /dev/tty.usbmodem14401
|
||||||
```
|
```
|
||||||
|
|
||||||
You should see tio printing `Disconnected` or `Connected` when you disconnect or reconnect the USB cable.
|
You should see tio printing `Disconnected` or `Connected` when you disconnect or reconnect the USB cable.
|
||||||
</TabItem>
|
</TabItem>
|
||||||
</Tabs>
|
</Tabs>
|
||||||
|
|
||||||
|
|
|
@ -105,7 +105,7 @@ Pick an MCU board:
|
||||||
|
|
||||||
:::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 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 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).
|
and edit / add necessary files according to the [guide for adding new keyboard shield](./dev-guide-new-shield.md).
|
||||||
:::
|
:::
|
||||||
|
|
||||||
|
|
Loading…
Add table
Reference in a new issue