diff options
author | Pete Johanson <peter@peterjohanson.com> | 2020-07-14 00:12:54 -0400 |
---|---|---|
committer | Pete Johanson <peter@peterjohanson.com> | 2020-07-14 00:12:54 -0400 |
commit | dd34edace1abe74de13621fd1ce14a5181140422 (patch) | |
tree | 9983e000b744db9f2bd7fc5f6b14f10fa7298a8f | |
parent | dca81c6579460e2693d07ecaf08cb5ad766484fe (diff) |
Remaining fixes.
-rw-r--r-- | docs/docs/dev-setup.md | 85 |
1 files changed, 81 insertions, 4 deletions
diff --git a/docs/docs/dev-setup.md b/docs/docs/dev-setup.md index aef09db..e4abdc9 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. </TabItem> -<TabItem value="win">Windows instructions are coming soon!</TabItem> +<TabItem value="win"> + +#### 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). + +</TabItem> <TabItem value="mac"> -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. </TabItem> </OsTabs> @@ -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: +<OsTabs> +<TabItem value="debian"> + +``` +source zephyr/zephyr-env.sh +``` + +</TabItem> + +<TabItem value="raspberryos"> + +``` +source zephyr/zephyr-env.sh +``` + +</TabItem> + +<TabItem value="fedora"> + ``` source zephyr/zephyr-env.sh ``` +</TabItem> + +<TabItem value="mac"> + +``` +source zephyr/zephyr-env.sh +``` + +</TabItem> + +<TabItem value="win"> + +``` +source zephyr/zephyr-env.cmd +``` + +</TabItem> +</OsTabs> + #### 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 +<Tabs +groupId="shell" +defaultValue="bash" +values={[ +{label: 'bash', value: 'bash'}, +{label: 'zsh', value: 'zsh'}, +{label: 'cmd.exe', value: 'cmd'}, +] +}> + +<TabItem value="bash"> ``` cat ~/.zephyrrc >> ~/.bashrc ``` -##### ZSH +</TabItem> + +<TabItem value="zsh"> ``` cat ~/.zephyrrc >> ~/.zshrc ``` +</TabItem> + +<TabItem value="cmd"> + +`cmd.exe` instructions coming soon! + +</TabItem> + +</Tabs> + ## Build From here on, building and flashing ZMK should all be done from the `app/` subdirectory of the ZMK checkout: |