diff --git a/docs/docs/development/setup/index.md b/docs/docs/development/setup/index.md index 5f24b113..5c795fa2 100644 --- a/docs/docs/development/setup/index.md +++ b/docs/docs/development/setup/index.md @@ -17,7 +17,4 @@ There are two ways to set up the ZMK development environment: - [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. - - - 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 4ed894cc..692bf694 100644 --- a/docs/docs/development/setup/native.mdx +++ b/docs/docs/development/setup/native.mdx @@ -199,33 +199,63 @@ pip install -r zephyr/scripts/requirements-base.txt -1. Install `west`, and make sure `~/.local/bin` is on your `PATH` environment variable: +1. Install `west`: ```sh pip3 install --user -U west +``` + +:::note +You need `~/.local/bin` to be on your `PATH` environment variable; verify that it is by running + +```sh +west --version +``` + +If this prints an error rather than a `west` version number, then add `~/.local/bin` to your `PATH`: + +```sh echo 'export PATH=~/.local/bin:"$PATH"' >> ~/.bashrc source ~/.bashrc ``` +::: -1. Install `west`, and make sure `~/.local/bin` is on your `PATH` environment variable: +1. Install `west`: ```sh pip install -U west ``` +:::note +You need the Python scripts directory to be on your PATH environment variable; verify that it is by running + +```sh +west --version +``` + +If this prints an error rather than a `west` version number, then add said directory to your `PATH` with PowerShell: + +```powershell +$Scripts = python -c "import sysconfig; print(sysconfig.get_path('scripts'))" +$Path = [Environment]::GetEnvironmentVariable('PATH', 'User') +[Environment]::SetEnvironmentVariable('PATH', "$Path;$Scripts", 'User') +$env:PATH += ";$Scripts" +``` + +::: + - - -1. Install `west` +1. Install `west`: ```sh pip3 install -U west ``` + @@ -258,7 +288,6 @@ pip3 install --user -r zephyr/scripts/requirements-base.txt - 4. Install the additional dependencies found in Zephyr's `requirements-base.txt`: ```sh diff --git a/docs/src/css/custom.css b/docs/src/css/custom.css index b9ad2255..99920d54 100644 --- a/docs/src/css/custom.css +++ b/docs/src/css/custom.css @@ -49,4 +49,4 @@ .secrettabs { display: none; -} \ No newline at end of file +}