diff options
author | Jack Sangdahl <[email protected]> | 2024-12-07 16:29:36 -0700 |
---|---|---|
committer | Jack Sangdahl <[email protected]> | 2024-12-07 16:29:36 -0700 |
commit | 08f55a8cd3cf4907f90c918d3f4473847910e215 (patch) | |
tree | b9cc40b2a5b21fb6457d9d3452424da956a1c729 | |
parent | ea7fc4e3129be8f6974ed7a46bbb856644e4612a (diff) | |
download | qmk_firmware-docs/tidy_install.tar.gz qmk_firmware-docs/tidy_install.zip |
Soft-wrap linesdocs/tidy_install
-rw-r--r-- | docs/newbs_getting_started.md | 19 |
1 files changed, 5 insertions, 14 deletions
diff --git a/docs/newbs_getting_started.md b/docs/newbs_getting_started.md index bf7d7164ba..8210d97d60 100644 --- a/docs/newbs_getting_started.md +++ b/docs/newbs_getting_started.md @@ -102,12 +102,7 @@ python3 -m pip install --user qmk ``` ::: tip -With the introduction of [PEP 668](https://peps.python.org/pep-0668), Python package management -tools like `pip` are no longer permitted to install Python packages globally on Linux -distributions that have adopted this PEP. As a result, the above command may not work in such -environments. To address this, recommended alternatives include using a Python virtual -environment or utilising [QMK's Docker container](getting_started_docker) for managing -dependencies. +With the introduction of [PEP 668](https://peps.python.org/pep-0668), Python package management tools like `pip` are no longer permitted to install Python packages globally on Linux distributions that have adopted this PEP. As a result, the above command may not work in such environments. To address this, recommended alternatives include using a Python virtual environment or utilising [QMK's Docker container](getting_started_docker) for managing dependencies. ::: :::: details Virtual Environment Setup @@ -118,17 +113,13 @@ git clone --recurse-submodules https://github.com/qmk/qmk_firmware.git cd qmk_firmware ``` -Create a virtual environment. The following command will create a `.venv` directory in your -current working directory. If you'd prefer to store the virtual environment elsewhere, adjust -the path accordingly: +Create a virtual environment. The following command will create a `.venv` directory in your current working directory. If you'd prefer to store the virtual environment elsewhere, adjust the path accordingly: ``` python3 -m venv .venv ``` -Activate the virtual environment. The following command works for most commonly used shells like -Bash, ZSH, sh, etc. If you are using Fish, Nu, or something else, see the alternate activation -scripts in `.venv/bin/`: +Activate the virtual environment. The following command works for most commonly used shells like Bash, ZSH, sh, etc. If you are using Fish, Nu, or something else, see the alternate activation scripts in `.venv/bin/`: ``` source .venv/bin/activate @@ -140,9 +131,9 @@ Install the QMK CLI package: pip install qmk ``` ::: tip -Using a virtual environment means it will need to be activated each time you plan to use the -utilities it provides (eg. `qmk` commands in this case). +Using a virtual environment means it will need to be activated each time you plan to use the utilities it provides (eg. `qmk` commands in this case). ::: + :::: ==== FreeBSD |