aboutsummaryrefslogtreecommitdiff
path: root/docs/cli.md
diff options
context:
space:
mode:
authorskullY <skullydazed@gmail.com>2020-04-20 17:35:40 -0700
committerZach White <skullydazed@users.noreply.github.com>2020-05-18 22:46:33 -0700
commitfcf150bd820195a169a5de2699cfa1f2d4d3d5a3 (patch)
tree10cc66f53d37fdd939a4e2e01cba76eeb2a68c0a /docs/cli.md
parentee2eb01653a8ba886e75971e710dcc52199935a3 (diff)
downloadqmk_firmware-fcf150bd820195a169a5de2699cfa1f2d4d3d5a3.tar.gz
qmk_firmware-fcf150bd820195a169a5de2699cfa1f2d4d3d5a3.zip
Streamline the macos install process
Diffstat (limited to 'docs/cli.md')
-rw-r--r--docs/cli.md9
1 files changed, 4 insertions, 5 deletions
diff --git a/docs/cli.md b/docs/cli.md
index 01641bd8b..8684479d0 100644
--- a/docs/cli.md
+++ b/docs/cli.md
@@ -13,18 +13,17 @@ QMK requires Python 3.6 or greater. We try to keep the number of requirements sm
13If you have installed [Homebrew](https://brew.sh) you can tap and install QMK: 13If you have installed [Homebrew](https://brew.sh) you can tap and install QMK:
14 14
15``` 15```
16brew tap qmk/qmk 16brew install qmk/qmk/qmk
17brew install qmk
18export QMK_HOME='~/qmk_firmware' # Optional, set the location for `qmk_firmware` 17export QMK_HOME='~/qmk_firmware' # Optional, set the location for `qmk_firmware`
19qmk setup # This will clone `qmk/qmk_firmware` and optionally set up your build environment 18qmk setup # This will clone `qmk/qmk_firmware` and optionally set up your build environment
20``` 19```
21 20
22### Install Using easy_install or pip :id=install-using-easy_install-or-pip 21### Install Using pip :id=install-using-easy_install-or-pip
23 22
24If your system is not listed above you can install QMK manually. First ensure that you have python 3.6 (or later) installed and have installed pip. Then install QMK with this command: 23If your system is not listed above you can install QMK manually. First ensure that you have Python 3.6 (or later) installed and have installed pip. Then install QMK with this command:
25 24
26``` 25```
27pip3 install qmk 26python3 -m pip install qmk
28export QMK_HOME='~/qmk_firmware' # Optional, set the location for `qmk_firmware` 27export QMK_HOME='~/qmk_firmware' # Optional, set the location for `qmk_firmware`
29qmk setup # This will clone `qmk/qmk_firmware` and optionally set up your build environment 28qmk setup # This will clone `qmk/qmk_firmware` and optionally set up your build environment
30``` 29```