From a1dd21651911df5dcd42e9980d91e51bef45dfe8 Mon Sep 17 00:00:00 2001 From: innovaker <66737976+innovaker@users.noreply.github.com> Date: Tue, 3 Nov 2020 13:11:56 +0000 Subject: [PATCH] docs: formatted with prettier --- docs/docs/dev-guide-new-shield.md | 6 +++--- docs/docs/dev-guide-usb-logging.md | 6 +++--- docs/docs/user-setup.md | 2 +- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/docs/dev-guide-new-shield.md b/docs/docs/dev-guide-new-shield.md index 7a0a248d..e1d6f250 100644 --- a/docs/docs/dev-guide-new-shield.md +++ b/docs/docs/dev-guide-new-shield.md @@ -28,11 +28,11 @@ ZMK support for split keyboards requires a few more files than single boards to ## New Shield Directory :::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 [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. For example, `app/boards/shields/` should now be +user config repository. For example, `app/boards/shields/` should now be `config/boards/shields/`. ::: @@ -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, 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 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. diff --git a/docs/docs/dev-guide-usb-logging.md b/docs/docs/dev-guide-usb-logging.md index adb2d661..50884be5 100644 --- a/docs/docs/dev-guide-usb-logging.md +++ b/docs/docs/dev-guide-usb-logging.md @@ -27,7 +27,7 @@ The following KConfig values need to be set, either by copy and pasting into the :::note If you are debugging your own keyboard in your [user config repository](./user-setup.md), use `config/boards/shields//.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. ::: @@ -90,14 +90,14 @@ If you already have the Ardunio IDE installed you can also use its built-in Seri -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)): ``` 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. diff --git a/docs/docs/user-setup.md b/docs/docs/user-setup.md index 566b62c4..990a8f6d 100644 --- a/docs/docs/user-setup.md +++ b/docs/docs/user-setup.md @@ -105,7 +105,7 @@ Pick an MCU board: :::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, +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). :::