diff options
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 c8916b0e2..a3022f15e 100644 --- a/docs/newbs_getting_started.md +++ b/docs/newbs_getting_started.md | |||
| @@ -66,9 +66,14 @@ After Homebrew is installed run these commands: | |||
| 66 | 66 | ||
| 67 | 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: | 67 | 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: |
| 68 | 68 | ||
| 69 | * Debian / Ubuntu / Devuan: `apt-get install git python3 && python3 -m pip install qmk` | 69 | * Debian / Ubuntu / Devuan: `sudo apt install git python3 python3-pip` |
| 70 | * Fedora / Red Hat / CentOS: `yum install git python3 && python3 -m pip install qmk` | 70 | * Fedora / Red Hat / CentOS: `sudo yum install git python3 python3-pip` |
| 71 | * Arch: `yay -S qmk` (or use any other AUR Helper) | 71 | * Arch / Manjaro: `sudo pacman -S git python python-pip python-setuptools libffi` |
| 72 | |||
| 73 | |||
| 74 | Install the global CLI to bootstrap your system: | ||
| 75 | |||
| 76 | `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`) | ||
| 72 | 77 | ||
| 73 | ## 3. Run QMK Setup :id=set-up-qmk | 78 | ## 3. Run QMK Setup :id=set-up-qmk |
| 74 | 79 | ||
| @@ -78,6 +83,12 @@ After installing QMK you can set it up with this command: | |||
| 78 | 83 | ||
| 79 | In most situations you will want to answer Yes to all of the prompts. | 84 | In most situations you will want to answer Yes to all of the prompts. |
| 80 | 85 | ||
| 86 | ?>**Note on Debian, Ubuntu and their derivatives**: | ||
| 87 | It's possible, that you will get an error saying something like: `bash: qmk: command not found`. | ||
| 88 | 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. | ||
| 89 | Sadly, Ubuntu reitroduced this bug and is [yet to fix it](https://bugs.launchpad.net/ubuntu/+source/bash/+bug/1588562). | ||
| 90 | Luckily, the fix is easy. Run this as your user: `echo "PATH=$HOME/.local/bin:$PATH" >> $HOME/.bashrc && source $HOME/.bashrc` | ||
| 91 | |||
| 81 | ?> 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. | 92 | ?> 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. |
| 82 | 93 | ||
| 83 | ## 4. Test Your Build Environment | 94 | ## 4. Test Your Build Environment |