pwarren/zmk_mf68
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Typo fix, add ™ properly.

Browse source
This commit is contained in:
Pete Johanson 2020-06-09 17:00:22 -04:00
parent 7cb7d705d6
commit 4ea641f34a
3 changed files with 10 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -1,11 +1,11 @@
# Zephyr Mechanical Keyboard (ZMK) Firmware # Zephyr™ Mechanical Keyboard (ZMK) Firmware
[![Build](https://github.com/zmkfirmware/zmk/workflows/Build/badge.svg)](https://github.com/zmkfirmware/zmk/actions) [![Build](https://github.com/zmkfirmware/zmk/workflows/Build/badge.svg)](https://github.com/zmkfirmware/zmk/actions)
[![Netlify Status](https://api.netlify.com/api/v1/badges/942d61a9-87c0-4c23-9b51-f5ed0bce495d/deploy-status)](https://app.netlify.com/sites/zmk/deploys) [![Netlify Status](https://api.netlify.com/api/v1/badges/942d61a9-87c0-4c23-9b51-f5ed0bce495d/deploy-status)](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 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/ Basic WIP website to learn more: https://zmk.netlify.app/

14
docs/docs/dev-setup.md
View file

@ -12,7 +12,7 @@ A unix-like environment with Python 3 installed. So far this has been tested on
### West Build Command ### 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 ```bash
pip install --user west 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. `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 export ZSDK_VERSION=0.11.3
@ -44,9 +44,9 @@ git clone https://github.com/zmkfirmware/zmk.git
### Initialize & Update Zephy Workspace ### 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 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 #### Initialize West
@ -60,7 +60,7 @@ west init -l app/
west update west update
``` ```
#### Export Zephyr Core #### Export Zephyr™ Core
```bash ```bash
west zephyr-export west zephyr-export
@ -89,7 +89,7 @@ west build -b proton_c -- -DSHIELD=kyria -DKEYMAP=default
### Keyboard With Onboard MCU ### 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: Given the following:

2
docs/docs/intro.md
View file

@ -5,7 +5,7 @@ sidebar_label: Introduction
--- ---
ZMK Firmware is an open source (MIT) keyboard 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 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 of licensing issues that prevent upstream BLE support as a first-class