Additional updates and tuning per PR feedback

This commit is contained in:
KemoNine 2020-12-02 14:17:44 +00:00
parent dbf4e05663
commit 4f6a2a6923
7 changed files with 42 additions and 74 deletions

View file

@ -10,7 +10,7 @@ The Docker environment will **NOT** run on arm CPUs like the Raspberry Pi. You m
:::note Windows Users :::note Windows Users
Please note the zmk builds can run slower with Docker on Windows if you don't use the WSL2 filesystem to store files. Build times can take 3-5 minutes on slower hardware without using the WSL2 filesystem. If you run into performance problems you can checkout the zmk sources inside a WSL2 environment and use `code .` inside the WSL2 environment to open the sources. This can make builds run as fast as 20s. Please note the zmk builds can run slower with Docker on Windows if you don't use the WSL2 filesystem to store files. Build times can take 3-5 minutes on slower hardware without using the WSL2 filesystem. If you run into performance problems you can checkout the zmk sources inside a WSL2 environment and use `code .` inside the WSL2 environment to open the sources. This can make builds run as fast as 20s.
This approach will also need the [Remote - WSL](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-wsl) extension installed in VS Code as well. This approach will also need the [Remote - WSL](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-wsl) extension installed in VS Code.
Files stored within WSL2 can be accessed via Windows Explorer by navigating to `\\wsl$`. Files stored within WSL2 can be accessed via Windows Explorer by navigating to `\\wsl$`.
::: :::
@ -21,6 +21,6 @@ This setup leverages the same [image which is used by the GitHub action](https:/
2. Install [VS Code](https://code.visualstudio.com/) 2. Install [VS Code](https://code.visualstudio.com/)
3. Install the [Remote - Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) 3. Install the [Remote - Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
:::info ## ZMK Sources Setup
Once the above is setup you're ready to setup the ZMK sources as defined [here](/docs/development/setup/zmk)
::: Once the above is setup you're ready to [set up the ZMK sources](/docs/development/setup/zmk).

View file

@ -0,0 +1,24 @@
---
title: Getting Started
sidebar_label: Getting Started
---
## Environment Setup
There are two ways to setup the zmk development environment: Docker+VS Code (Docker in the rest of the documentation) and using the operating system directly (native in the rest of the documentation). The Docker approach is a self-contained development environment while the native approach will setup your local operating system for development. The Docker approach is great for getting going quickly while the native approach is a bit faster but more difficult to setup initially.
Please see the [Docker](/docs/development/setup/docker-vscode) instructions or [native](/docs/development/setup/native) instructions to continue setup.
:::danger
The Docker environment will **NOT** run on arm CPUs like the Raspberry Pi. You must use the native environment if using an arm CPU.
:::
## Standard Conventions
Throughout this documentation you will see commands like
```
sudo apt update
```
These commands should be run in a terminal such as Bash (Linux/macOS/Docker), PowerShell, or Command Prompt (Windows).

View file

@ -430,6 +430,6 @@ cat ~/.zephyrrc >> ~/.zshrc
</Tabs> </Tabs>
:::info ## ZMK Sources Setup
Once the above is setup you're ready to setup the ZMK sources as defined [here](/docs/development/setup/zmk)
::: Once the above is setup you're ready to [set up the ZMK sources](/docs/development/setup/zmk).

View file

@ -1,28 +0,0 @@
---
title: Getting Started
sidebar_label: Getting Started
---
## Environment Setup
There are 2 ways to setup the zmk development environment: Docker+VS Code (Docker in the rest of the documentation) and using the operating system directly (native in the rest of the documentation). The Docker approach is a self-contained development environment while the native approach will setup your local operating system for development. The Docker approach is great for getting going quickly while the native approach is a bit faster but more difficult to setup initially.
Please see the [Docker](/docs/development/setup/docker-vscode) instructions or [native](/docs/development/setup/native) instructions to continue setup.
:::danger
The Docker environment will **NOT** run on arm CPUs like the Raspberry Pi. You must use the native environment if using an arm CPU.
:::
## ZMK Sources Setup
Once you've setup either the Docker environment or native environment you will need to setup the ZMK sources. Please see the [ZMK Sources](/docs/development/setup/zmk) section once you've setup your chosen environment.
## Standard Conventions
Throughout this documentation you will see commands like
```
sudo apt update
```
These commands should be run in a terminal such as Bash (Linux/macOS/Docker), PowerShell, or Command Prompt (Windows).

View file

@ -11,18 +11,14 @@ groupId="operating-systems"
defaultValue="docker" defaultValue="docker"
values={[ values={[
{label: 'VS Code & Docker', value: 'docker'}, {label: 'VS Code & Docker', value: 'docker'},
{label: 'Debian/Ubuntu', value: 'debian'}, {label: 'Native', value: 'native'},
{label: 'macOS', value: 'mac'},
{label: 'Windows', value: 'win'},
{label: 'Raspberry OS', value: 'raspberryos'},
{label: 'Fedora', value: 'fedora'},
] ]
}>{props.children}</Tabs>); }>{props.children}</Tabs>);
:::caution Windows Users :::caution Windows Users
If you're using the Docker environment on Windows, you _must_ checkout the sources to a folder within `C:\Users\[your_user_here]` to avoid a potential permissions issue. If you're using the Docker environment on Windows, you _must_ checkout the sources to a folder within `C:\Users\[your_user_here]` to avoid a potential permissions issue.
If you're using the WSL2 native filesystem the sources should go under `~/` to avoid potential permissions issues. If you're using the WSL2 filesystem the sources should go under `~/` to avoid potential permissions issues.
::: :::
### Source Code ### Source Code
@ -58,35 +54,7 @@ All subsequent steps must be performed from the VS Code terminal _inside_ the co
</TabItem> </TabItem>
<TabItem value="debian"> <TabItem value="native">
```sh
cd zmk
```
</TabItem>
<TabItem value="raspberryos">
```sh
cd zmk
```
</TabItem>
<TabItem value="fedora">
```sh
cd zmk
```
</TabItem>
<TabItem value="mac">
```sh
cd zmk
```
</TabItem>
<TabItem value="win">
```sh ```sh
cd zmk cd zmk
@ -101,9 +69,9 @@ cd zmk
west init -l app/ west init -l app/
``` ```
:::caution Command Not Found? (Native OS) :::caution Command Not Found?
If you encounter errors like `command not found: west` then your `PATH` environment variable is likely If you encounter errors like `command not found: west` then your `PATH` environment variable is likely
missing the Python 3 user packages directory. See the [West Build Command](#west-build-command) missing the Python 3 user packages directory. See the [Native setup](native/)
section again for links to how to do this section again for links to how to do this
::: :::
@ -125,6 +93,10 @@ west zephyr-export
#### Install Zephyr Python Dependencies #### Install Zephyr Python Dependencies
:::note
This only need to be run when using the Native setup.
:::
```sh ```sh
pip3 install --user -r zephyr/scripts/requirements-base.txt pip3 install --user -r zephyr/scripts/requirements-base.txt
``` ```

View file

@ -48,7 +48,7 @@ module.exports = {
}, },
{ {
label: "Development", label: "Development",
to: "docs/development/setup/setup", to: "docs/development/setup/getting-started",
}, },
], ],
}, },

View file

@ -48,7 +48,7 @@ module.exports = {
label: "Setup", label: "Setup",
collapsed: false, collapsed: false,
items: [ items: [
"development/setup/setup", "development/setup/getting-started",
"development/setup/docker-vscode", "development/setup/docker-vscode",
"development/setup/native", "development/setup/native",
"development/setup/zmk", "development/setup/zmk",