diff options
| author | Idan Gazit <idan@gazit.me> | 2020-10-09 18:48:41 -0700 |
|---|---|---|
| committer | Idan Gazit <idan@gazit.me> | 2020-10-09 19:09:11 -0700 |
| commit | 5c00c97e9a1647e2676586c303d19c5559e2e2f1 (patch) | |
| tree | 831242e57ef87575b5f8d72306c3f225ffe26b11 /docs | |
| parent | 63ad5b7c089f13a5b5d5514514cc9ad7e798d3e8 (diff) | |
Wrap up documentation
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/docs/assets/dev-setup/vscode_devcontainer.png | bin | 0 -> 20773 bytes | |||
| -rw-r--r-- | docs/docs/dev-setup.md | 62 |
2 files changed, 62 insertions, 0 deletions
diff --git a/docs/docs/assets/dev-setup/vscode_devcontainer.png b/docs/docs/assets/dev-setup/vscode_devcontainer.png Binary files differnew file mode 100644 index 0000000..e5c22b0 --- /dev/null +++ b/docs/docs/assets/dev-setup/vscode_devcontainer.png diff --git a/docs/docs/dev-setup.md b/docs/docs/dev-setup.md index be3d6f9..6ef0f02 100644 --- a/docs/docs/dev-setup.md +++ b/docs/docs/dev-setup.md @@ -369,12 +369,63 @@ Since ZMK is built as a Zephyr™ application, the next step is to use `west` to initialize and update your workspace. The ZMK Zephyr™ application is in the `app/` source directory: + #### Step into the repository +<OsTabs> +<TabItem value="debian"> + +```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 cd zmk ``` +</TabItem> + +<TabItem value="docker"> + +Open the `zmk` checkout folder in VS Code. The repository includes a configuration for containerized development, so an alert will pop up: + + + +Click `Reopen in Container` in order to reopen the VS Code with the running container. + +The first time you do this on your machine, it will pull the docker image down from the registry and build the container. Subsequent launches are much faster! + +:::caution +All subsequent steps must be performed from the VS Code terminal _inside_ the container. +::: + +</TabItem> +</OsTabs> + #### Initialize West ```sh @@ -393,6 +444,17 @@ section again for links to how to do this west update ``` +:::tip +This step pulls down quite a bit of tooling. Go grab a cup of coffee, it can take 10-15 minutes even on a good internet connection! +::: + +:::info +If you're using Docker, you're done with setup! You must restart the container at this point. The easiest way to do so is to close the VS Code window, verify that the container has stopped in Docker Dashboard, and reopen the container with VS Code. + +Once your container is restarted, proceed to [Building and Flashing](./dev-build.md). +::: + + #### Export Zephyr™ Core ```sh |
