diff options
| author | Erovia <Erovia@users.noreply.github.com> | 2020-04-27 21:29:31 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-04-27 20:29:31 +0100 |
| commit | 2c0deb8a1366fadec9892b762423f5f94357fb03 (patch) | |
| tree | 684f52614ebb87abd23d810ed4d63deea96bf9e8 /docs | |
| parent | a904371b29e50d0d338b7ff0a9abfdffc5dcb426 (diff) | |
| download | qmk_firmware-2c0deb8a1366fadec9892b762423f5f94357fb03.tar.gz qmk_firmware-2c0deb8a1366fadec9892b762423f5f94357fb03.zip | |
Update and try to clarify the CLI installation on Linux (#8783)
* Update and try to clarify the CLI installation on Linux
* Update commands, add note for Debian/Ubuntu
* Update docs/newbs_getting_started.md
Co-Authored-By: Joel Challis <git@zvecr.com>
Co-authored-by: Joel Challis <git@zvecr.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/newbs_getting_started.md | 17 |
1 files changed, 14 insertions, 3 deletions
diff --git a/docs/newbs_getting_started.md b/docs/newbs_getting_started.md index c8916b0e2f..a3022f15e5 100644 --- a/docs/newbs_getting_started.md +++ b/docs/newbs_getting_started.md @@ -66,9 +66,14 @@ After Homebrew is installed run these commands: You will need to install Git and Python. It's very likely that you already have both, but if not, one of the following commands should install them: -* Debian / Ubuntu / Devuan: `apt-get install git python3 && python3 -m pip install qmk` -* Fedora / Red Hat / CentOS: `yum install git python3 && python3 -m pip install qmk` -* Arch: `yay -S qmk` (or use any other AUR Helper) +* Debian / Ubuntu / Devuan: `sudo apt install git python3 python3-pip` +* Fedora / Red Hat / CentOS: `sudo yum install git python3 python3-pip` +* Arch / Manjaro: `sudo pacman -S git python python-pip python-setuptools libffi` + + +Install the global CLI to bootstrap your system: + + `python3 -m pip install --user qmk` (on Arch-based distros you can also try the `qmk` package from AUR (**note**: it's maintained by a community member): `yay -S qmk`) ## 3. Run QMK Setup :id=set-up-qmk @@ -78,6 +83,12 @@ After installing QMK you can set it up with this command: In most situations you will want to answer Yes to all of the prompts. +?>**Note on Debian, Ubuntu and their derivatives**: +It's possible, that you will get an error saying something like: `bash: qmk: command not found`. +This is due to a [bug](https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=839155) Debian introduced with their Bash 4.4 release, which removed `$HOME/.local/bin` from the PATH. This bug was later fixed on Debian and Ubuntu. +Sadly, Ubuntu reitroduced this bug and is [yet to fix it](https://bugs.launchpad.net/ubuntu/+source/bash/+bug/1588562). +Luckily, the fix is easy. Run this as your user: `echo "PATH=$HOME/.local/bin:$PATH" >> $HOME/.bashrc && source $HOME/.bashrc` + ?> If you already know [how to use GitHub](getting_started_github.md), we recommend that you create your own fork and use `qmk setup <github_username>/qmk_firmware` to clone your personal fork. If you don't know what that means you can safely ignore this message. ## 4. Test Your Build Environment |