diff --git a/docs/docs/development/setup/index.md b/docs/docs/development/setup/index.md index b4abac92..5f24b113 100644 --- a/docs/docs/development/setup/index.md +++ b/docs/docs/development/setup/index.md @@ -11,11 +11,13 @@ We recommend reading through the setup process before following it step by step, There are two ways to set up the ZMK development environment: -- [Docker](/docs/development/setup/docker) ; -- [Native](/docs/development/setup/native), i.e. using the operating system directly. +- [Docker](/docs/development/setup/docker): \ + A self-contained development environment. It uses the same [Docker image which is used by the GitHub action](https://github.com/zmkfirmware/zmk-docker) for local development. Beyond the benefits of [dev/prod parity](https://12factor.net/dev-prod-parity), this approach may be easier to set up for some operating systems. No toolchain or dependencies are necessary when using Docker; the container image has the toolchain installed and set up to use. + +- [Native](/docs/development/setup/native):\ + This uses your operating system directly. Usually runs slightly faster than the Docker approach, and can be preferable for users who already have the dependencies on their system. + -The Docker approach is a self-contained development environment while the native approach will setup your local operating system for development. It uses the same [Docker image which is used by the GitHub action](https://github.com/zmkfirmware/zmk-docker) for local development. Beyond the benefits of [dev/prod parity](https://12factor.net/dev-prod-parity), this approach may be easier to set up for some operating systems. No toolchain or dependencies are necessary when using Docker; the container image has the toolchain installed and set up to use. -The native approach installs the toolchain and dependencies on your system directly. This typically runs slightly faster than the Docker approach, and can be preferable for users who already have the dependencies on their system. Please see the [Docker](/docs/development/setup/docker) instructions or [native](/docs/development/setup/native) instructions to continue setup. diff --git a/docs/docs/development/setup/native.mdx b/docs/docs/development/setup/native.mdx index 8afdb1b4..4ed894cc 100644 --- a/docs/docs/development/setup/native.mdx +++ b/docs/docs/development/setup/native.mdx @@ -100,8 +100,8 @@ These steps are very similar to Zephyr's [Get Zephyr and install Python dependen - - + + 1. Use `apt` to install Python `venv` package: @@ -117,8 +117,7 @@ source .venv/bin/activate ``` - - + 1. Create a new virtual environment: ```sh @@ -144,7 +143,8 @@ python -m venv .venv - + + 1. Create a new virtual environment: ```sh @@ -158,7 +158,7 @@ source .venv/bin/activate ``` - + Once activated your shell will be prefixed with `(.venv)`. The virtual environment can be deactivated at any time by running `deactivate`. @@ -197,8 +197,8 @@ pip install -r zephyr/scripts/requirements-base.txt - - + + 1. Install `west`, and make sure `~/.local/bin` is on your `PATH` environment variable: ```sh @@ -207,6 +207,28 @@ echo 'export PATH=~/.local/bin:"$PATH"' >> ~/.bashrc source ~/.bashrc ``` + + + +1. Install `west`, and make sure `~/.local/bin` is on your `PATH` environment variable: + +```sh +pip install -U west +``` + + + + + + +1. Install `west` + +```sh +pip3 install -U west +``` + + + 2. Initialize the application and update to fetch modules, including Zephyr: ```sh @@ -224,6 +246,9 @@ This step pulls down quite a bit of tooling, be patient! west zephyr-export ``` + + + 4. Install the additional dependencies found in Zephyr's `requirements-base.txt`: ```sh @@ -231,29 +256,8 @@ pip3 install --user -r zephyr/scripts/requirements-base.txt ``` - -1. Install `west`, and make sure `~/.local/bin` is on your `PATH` environment variable: + -```sh -pip install -U west -``` - -2. Initialize the application and update to fetch modules, including Zephyr: - -```sh -west init -l app/ -west update -``` - -:::tip -This step pulls down quite a bit of tooling, be patient! -::: - -3. Export a [Zephyr CMake package](https://docs.zephyrproject.org/3.5.0/build/zephyr_cmake_package.html#cmake-pkg). This allows CMake to automatically load boilerplate code required for building Zephyr applications. - -```sh -west zephyr-export -``` 4. Install the additional dependencies found in Zephyr's `requirements-base.txt`: @@ -262,39 +266,15 @@ pip install -r zephyr/scripts/requirements-base.txt ``` - - -1. Install `west` - -```sh -pip3 install -U west -``` - -2. Initialize the application and update to fetch modules, including Zephyr: - -```sh -west init -l app/ -west update -``` - -:::tip -This step pulls down quite a bit of tooling, be patient! -::: - -3. Export a [Zephyr CMake package](https://docs.zephyrproject.org/3.5.0/build/zephyr_cmake_package.html#cmake-pkg). This allows CMake to automatically load boilerplate code required for building Zephyr applications. - -```sh -west zephyr-export -``` - + 4. Install the additional dependencies found in Zephyr's `requirements-base.txt`. ```sh -pip3 install -r ~/zephyrproject/zephyr/scripts/requirements-base.txt +pip3 install -r zephyr/scripts/requirements-base.txt ``` - + diff --git a/docs/src/css/custom.css b/docs/src/css/custom.css index c2df00e2..b9ad2255 100644 --- a/docs/src/css/custom.css +++ b/docs/src/css/custom.css @@ -46,3 +46,7 @@ width: 100%; height: 100%; } + +.secrettabs { + display: none; +} \ No newline at end of file