kb01/zmk
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Simplify Docker page and make header levels consistent

Browse source
This commit is contained in:
Cem Aksoylar 2024-06-01 21:35:10 -07:00
parent 40d38a8eec
commit d6d2bff8a2
1 changed files with 3 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
docs/docs/development/setup/docker.md
View file

@ -15,7 +15,7 @@ First, you'll need to clone the ZMK source repository if you haven't already. Op
git clone https://github.com/zmkfirmware/zmk.git git clone https://github.com/zmkfirmware/zmk.git
``` ```
## Installing Development Tools ### Installing Development Tools
1. Install [Docker Desktop](https://www.docker.com/products/docker-desktop) for your operating system. 1. Install [Docker Desktop](https://www.docker.com/products/docker-desktop) for your operating system.
2. Install [VS Code](https://code.visualstudio.com/). 2. Install [VS Code](https://code.visualstudio.com/).
@ -23,12 +23,6 @@ git clone https://github.com/zmkfirmware/zmk.git
### Initialize & Update Zephyr Workspace ### Initialize & Update Zephyr Workspace
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
Open the `zmk` checkout folder in VS Code. The repository includes a configuration for containerized development, so an alert will pop up: Open the `zmk` checkout folder in VS Code. The repository includes a configuration for containerized development, so an alert will pop up:
![VS Code Dev Container Configuration Alert](../../assets/dev-setup/vscode_devcontainer.png) ![VS Code Dev Container Configuration Alert](../../assets/dev-setup/vscode_devcontainer.png)
@ -38,18 +32,13 @@ Click `Reopen in Container` in order to reopen the VS Code with the running cont
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! 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 :::caution
All subsequent steps must be performed from the VS Code terminal _inside_ the container. The following step and any future [build commands](../build-flash.mdx) must be executed from the VS Code terminal _inside_ the container.
::: :::
#### Initialize West Initialize the application and update to fetch modules, including Zephyr:
```sh ```sh
west init -l app/ west init -l app/
```
#### Update To Fetch Modules
```sh
west update west update
``` ```