aboutsummaryrefslogtreecommitdiff
path: root/docs/cli.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/cli.md')
-rw-r--r--docs/cli.md12
1 files changed, 6 insertions, 6 deletions
diff --git a/docs/cli.md b/docs/cli.md
index 165f2a372..760fe1cdb 100644
--- a/docs/cli.md
+++ b/docs/cli.md
@@ -1,14 +1,14 @@
1# QMK CLI 1# QMK CLI :id=qmk-cli
2 2
3## Overview 3## Overview :id=overview
4 4
5The QMK CLI makes building and working with QMK keyboards easier. We have provided a number of commands to simplify and streamline tasks such as obtaining and compiling the QMK firmware, creating keymaps, and more. 5The QMK CLI makes building and working with QMK keyboards easier. We have provided a number of commands to simplify and streamline tasks such as obtaining and compiling the QMK firmware, creating keymaps, and more.
6 6
7### Requirements 7### Requirements :id=requirements
8 8
9The CLI requires Python 3.5 or greater. We try to keep the number of requirements small but you will also need to install the packages listed in [`requirements.txt`](https://github.com/qmk/qmk_firmware/blob/master/requirements.txt). These are installed automatically when you install the QMK CLI. 9The CLI requires Python 3.5 or greater. We try to keep the number of requirements small but you will also need to install the packages listed in [`requirements.txt`](https://github.com/qmk/qmk_firmware/blob/master/requirements.txt). These are installed automatically when you install the QMK CLI.
10 10
11### Install Using Homebrew (macOS, some Linux) 11### Install Using Homebrew (macOS, some Linux) :id=install-using-homebrew
12 12
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
@@ -19,7 +19,7 @@ export 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 19qmk setup # This will clone `qmk/qmk_firmware` and optionally set up your build environment
20``` 20```
21 21
22### Install Using easy_install or pip 22### Install Using easy_install or pip :id=install-using-easy_install-or-pip
23 23
24If your system is not listed above you can install QMK manually. First ensure that you have python 3.5 (or later) installed and have installed pip. Then install QMK with this command: 24If your system is not listed above you can install QMK manually. First ensure that you have python 3.5 (or later) installed and have installed pip. Then install QMK with this command:
25 25
@@ -29,7 +29,7 @@ export 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 29qmk setup # This will clone `qmk/qmk_firmware` and optionally set up your build environment
30``` 30```
31 31
32### Packaging For Other Operating Systems 32### Packaging For Other Operating Systems :id=packaging-for-other-operating-systems
33 33
34We are looking for people to create and maintain a `qmk` package for more operating systems. If you would like to create a package for your OS please follow these guidelines: 34We are looking for people to create and maintain a `qmk` package for more operating systems. If you would like to create a package for your OS please follow these guidelines:
35 35