Initial work on basic documentation.

This commit is contained in:
Pete Johanson
2020-05-25 21:33:21 -04:00
parent 96b87b2594
commit e00408d746
19 changed files with 13924 additions and 0 deletions

View File

@@ -0,0 +1,26 @@
---
id: dev-posix-board
title: Native Posix board target
---
In order to iterate quickly on firmware features, it can
be helpful to build and run the firmware on your local
workstation, with generated virtual press/release events
flowing into the handler functions.
To do this, you can build ZMK targetting the
`native_posix` board.
```
west build --pristine --board native_posix
```
Once built, you can run the firmware locally:
```
./build/zephyr/zephyr.exe
```
## Virtual Key Events
The virtual key presses are hardcoded in `boards/native_posix.overlay` file. should you want to change the sequence to test various actions like Mod-Tap, etc.

12
docs/docs/dev-setup.md Normal file
View File

@@ -0,0 +1,12 @@
---
id: dev-setup
title: Basic Setup
sidebar_label: Basic Setup
---
1. Install `west` from pip.
1. Install the ARM SDK from Zephyr project.
1. (Optional) Install 32-bit libs for building and testing locally.
1. `west init -l zmk`
1. Build it.
1. Flash it.

13
docs/docs/hardware.md Normal file
View File

@@ -0,0 +1,13 @@
---
id: hardware
title: Supported Hardware
sidebar_label: Supported Hardware
---
:::warning
ZMK Firmware is still _completely_ untested on real KB hardware. It is pre-pre-pre-alpha quality.
:::
Current development of ZMK is focused on ARM, in particular stm32, MCUs, including the stm32wb for bluetooth support.

10
docs/docs/intro.md Normal file
View File

@@ -0,0 +1,10 @@
---
id: intro
title: Introduction to ZMK
sidebar_label: Introduction
---
ZMK Firmware is an open source (Apache 2.0) keyboard
firmware built on the [Zephyr Project](https://zephyrproject.com/) RTOS.