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

More doc tweaks for SDK install and build clarity.

Browse source 
* Suggest installing SDK to `~/.local` directory.
* Clarify about switching to `app/` before build/flash.
This commit is contained in:
Pete Johanson 2020-06-10 11:00:03 -04:00
parent 2f4bc94b7e
commit 6ef823be3a
1 changed files with 8 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -85,7 +85,7 @@ To build firmwares for the ARM architecture (all supported MCUs/keyboards at thi
``` ```
export ZSDK_VERSION=0.11.2 export ZSDK_VERSION=0.11.2
wget -q "https://github.com/zephyrproject-rtos/sdk-ng/releases/download/v${ZSDK_VERSION}/zephyr-toolchain-arm-${ZSDK_VERSION}-setup.run" && \ wget -q "https://github.com/zephyrproject-rtos/sdk-ng/releases/download/v${ZSDK_VERSION}/zephyr-toolchain-arm-${ZSDK_VERSION}-setup.run" && \
sh "zephyr-toolchain-arm-${ZSDK_VERSION}-setup.run" --quiet -- -d /opt/toolchains/zephyr-sdk-${ZSDK_VERSION} && \ sh "zephyr-toolchain-arm-${ZSDK_VERSION}-setup.run" --quiet -- -d ~/.local/zephyr-sdk-${ZSDK_VERSION} && \
rm "zephyr-toolchain-arm-${ZSDK_VERSION}-setup.run" rm "zephyr-toolchain-arm-${ZSDK_VERSION}-setup.run"
``` ```
@ -167,8 +167,13 @@ cat ~/.zephyrrc >> ~/.zshrc
## Build ## Build
Actually building the ZMK firmware occurs within the `app/` subdirectory From here on, building and flashing ZMK should all be done from the `app/` subdirectory of the ZMK checkout:
of the ZMK repository. To build for your particular keyboard, the behaviour varies slightly depending on if you are building for a keyboard with
```bash
cd app
```
To build for your particular keyboard, the behaviour varies slightly depending on if you are building for a keyboard with
an onboard MCU, or one that uses a MCU board addon. an onboard MCU, or one that uses a MCU board addon.
### Keyboard (Shield) + MCU Board ### Keyboard (Shield) + MCU Board