Added a note to clarify requirements-base

This commit is contained in:
Nicolas Munnich 2024-04-19 19:44:22 +02:00
parent f2bedb0a76
commit afc353241e
2 changed files with 41 additions and 0 deletions

View file

@ -52,6 +52,16 @@ Return to this guide once you are finished with all four sections.
Zephyr's [Install Linux Host Dependencies](https://docs.zephyrproject.org/3.5.0/develop/getting_started/installation_linux.html) page may be of use for distributions which are not based on Ubuntu.
:::info
ZMK does not need all of the additional dependencies found in Zephyr's `requirements.txt`, only those found in `requirements-base.txt`
```diff
- pip3 install -r zephyr/scripts/requirements.txt
+ pip3 install -r zephyr/scripts/requirements-base.txt
```
:::
</TabItem>
<TabItem value="win">
@ -66,6 +76,16 @@ Return to this guide once you are finished with all four sections.
`dfu-util` is required to flash devices that use DFU, but there is currently no maintained package for it on Chocolatey. [QMK Toolbox](https://github.com/qmk/qmk_toolbox) contains a working version of it though.
:::info
ZMK does not need all of the additional dependencies found in Zephyr's `requirements.txt`, only those found in `requirements-base.txt`
```diff
- pip3 install -r zephyr/scripts/requirements.txt
+ pip3 install -r zephyr/scripts/requirements-base.txt
```
:::
</TabItem>
<TabItem value="mac">
@ -78,6 +98,16 @@ Open Zephyr's [Getting Started Guide](https://docs.zephyrproject.org/3.5.0/devel
Return to this guide once you are finished with all four sections.
:::info
ZMK does not need all of the additional dependencies found in Zephyr's `requirements.txt`, only those found in `requirements-base.txt`
```diff
- pip3 install -r zephyr/scripts/requirements.txt
+ pip3 install -r zephyr/scripts/requirements-base.txt
```
:::
</TabItem>
<TabItem value="raspberryos">
@ -92,6 +122,16 @@ Open Zephyr's [Getting Started Guide](https://docs.zephyrproject.org/3.5.0/devel
Return to this guide once you are finished with all four sections.
:::info
ZMK does not need all of the additional dependencies found in Zephyr's `requirements.txt`, only those found in `requirements-base.txt`
```diff
- pip3 install -r zephyr/scripts/requirements.txt
+ pip3 install -r zephyr/scripts/requirements-base.txt
```
:::
#### Install Cross-Compile Toolchain
Because Raspberry OS runs on the same architecture (but different ABI) as ARM keyboard MCUs, the operating system's installed [cross compilers](https://docs.zephyrproject.org/3.5.0/develop/toolchains/other_x_compilers.html) can be used to target the different ABI. Building for non-ARM MCUs has not been tested.

View file

@ -31,6 +31,7 @@ module.exports = {
"linker-script",
"log",
"powershell",
"diff",
],
theme,
darkTheme,