From dd34edace1abe74de13621fd1ce14a5181140422 Mon Sep 17 00:00:00 2001 From: Pete Johanson Date: Tue, 14 Jul 2020 00:12:54 -0400 Subject: [PATCH] Remaining fixes. --- docs/docs/dev-setup.md | 85 ++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 81 insertions(+), 4 deletions(-) diff --git a/docs/docs/dev-setup.md b/docs/docs/dev-setup.md index aef09db5..e4abdc95 100644 --- a/docs/docs/dev-setup.md +++ b/docs/docs/dev-setup.md @@ -263,10 +263,27 @@ wget -q "https://github.com/zephyrproject-rtos/sdk-ng/releases/download/v${ZSDK_ The installation will prompt with several questions about installation location, and creating a default `~/.zephyrrc` for you with various variables. The defaults shouldn normally work as expected. -Windows instructions are coming soon! + + +#### GNU ARM Embedded + +Since the Zephyr™ SDK is not available for Windows, we recommending following the steps to install the [GNU ARM Embedded](https://docs.zephyrproject.org/latest/getting_started/toolchain_3rd_party_x_compilers.html#gnu-arm-embedded). + + -Instructions for macOS coming soon. +#### 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: + +``` +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" && \ + sh "zephyr-toolchain-arm-${ZSDK_VERSION}-setup.run" --quiet -- -d ~/.local/zephyr-sdk-${ZSDK_VERSION} && \ + rm "zephyr-toolchain-arm-\${ZSDK_VERSION}-setup.run" +``` + +The installation will prompt with several questions about installation location, and creating a default `~/.zephyrrc` for you with various variables. The defaults shouldn normally work as expected. @@ -330,27 +347,87 @@ We suggest two main [options](https://docs.zephyrproject.org/latest/guides/env_v To load the Zephyr environment properly for just one transient shell, run the following from your ZMK checkout directory: + + + ``` source zephyr/zephyr-env.sh ``` + + + + +``` +source zephyr/zephyr-env.sh +``` + + + + + +``` +source zephyr/zephyr-env.sh +``` + + + + + +``` +source zephyr/zephyr-env.sh +``` + + + + + +``` +source zephyr/zephyr-env.cmd +``` + + + + #### All Shells To load the environment variables for your shell every time, append the existing `~/.zephyrrc` file to your shell's RC file and then start a new shell. -##### Bash + + + ``` cat ~/.zephyrrc >> ~/.bashrc ``` -##### ZSH + + + ``` cat ~/.zephyrrc >> ~/.zshrc ``` + + + + +`cmd.exe` instructions coming soon! + + + + + ## Build From here on, building and flashing ZMK should all be done from the `app/` subdirectory of the ZMK checkout: