diff options
| -rw-r--r-- | README.md | 4 | ||||
| -rw-r--r-- | docs/docs/dev-setup.md | 14 | ||||
| -rw-r--r-- | docs/docs/intro.md | 2 |
3 files changed, 10 insertions, 10 deletions
@@ -1,11 +1,11 @@ -# Zephyr Mechanical Keyboard (ZMK) Firmware +# Zephyr™ Mechanical Keyboard (ZMK) Firmware [](https://github.com/zmkfirmware/zmk/actions) [](https://app.netlify.com/sites/zmk/deploys) This project is a complete work in progress, with absolutely nothing functioning yet. The goal is to explore a new MK firmware -with a less restritive license and better BLE support, built on top of the [Zephyr Project](https://www.zephyrproject.org/) +with a less restritive license and better BLE support, built on top of the [Zephyr™ Project](https://www.zephyrproject.org/) Basic WIP website to learn more: https://zmk.netlify.app/ diff --git a/docs/docs/dev-setup.md b/docs/docs/dev-setup.md index 286b30c..9946438 100644 --- a/docs/docs/dev-setup.md +++ b/docs/docs/dev-setup.md @@ -12,7 +12,7 @@ A unix-like environment with Python 3 installed. So far this has been tested on ### West Build Command -`west` is the [Zephyr meta-tool](https://docs.zephyrproject.org/latest/guides/west/index.html) used to configure and build Zephyr applications. It can be installed by using the `pip` python package manager: +`west` is the [Zephyr™ meta-tool](https://docs.zephyrproject.org/latest/guides/west/index.html) used to configure and build Zephyr™ applications. It can be installed by using the `pip` python package manager: ```bash pip install --user west @@ -23,9 +23,9 @@ If you don't already have it configured, you may need to update your `PATH` to include the pip install path. See [User Installs](https://pip.pypa.io/en/stable/user_guide/#user-installs) and (Stack Overflow)[https://stackoverflow.com/questions/38112756/how-do-i-access-packages-installed-by-pip-user] for more details. ::: -### Zephyr ARM SDK +### Zephyr™ ARM SDK -To build firmwares for the ARM architecture (all supported MCUs/keyboards at this point), you'll need to install the Zephyr ARM SDK to your system: +To build firmwares for the ARM architecture (all supported MCUs/keyboards at this point), you'll need to install the Zephyr™ ARM SDK to your system: ``` export ZSDK_VERSION=0.11.3 @@ -44,9 +44,9 @@ git clone https://github.com/zmkfirmware/zmk.git ### Initialize & Update Zephy Workspace -Since ZMK is build as a Zephyr application, the next step is +Since ZMK is built as a Zephyr™ application, the next step is to use `west` to initialize and update your workspace. The ZMK -Zephyr application is in the `app/` source directory: +Zephyr™ application is in the `app/` source directory: #### Initialize West @@ -60,7 +60,7 @@ west init -l app/ west update ``` -#### Export Zephyr Core +#### Export Zephyr™ Core ```bash west zephyr-export @@ -89,7 +89,7 @@ west build -b proton_c -- -DSHIELD=kyria -DKEYMAP=default ### Keyboard With Onboard MCU -Keyboards with onboard MCU chips are simply treated as the [board](https://docs.zephyrproject.org/latest/guides/porting/board_porting.html) as far as Zephyr is concerned. +Keyboards with onboard MCU chips are simply treated as the [board](https://docs.zephyrproject.org/latest/guides/porting/board_porting.html) as far as Zephyr™ is concerned. Given the following: diff --git a/docs/docs/intro.md b/docs/docs/intro.md index 82def2f..f38d293 100644 --- a/docs/docs/intro.md +++ b/docs/docs/intro.md @@ -5,7 +5,7 @@ sidebar_label: Introduction --- ZMK Firmware is an open source (MIT) keyboard -firmware built on the [Zephyr Project](https://zephyrproject.com/) RTOS. +firmware built on the [Zephyr™ Project](https://zephyrproject.com/) RTOS. The goal is to provider a powerful, featureful keyboard firmware that is free of licensing issues that prevent upstream BLE support as a first-class |