Henry-Hiles/qmk_userspace
1
0
Fork 0
forked from mirrors/qmk_userspace
Code Pull requests Activity

Refactor qmk compile-json to qmk compile (#6592)

Browse source
This commit is contained in:
skullydazed 2019-08-25 11:58:24 -07:00 • committed by GitHub
parent c289a4cb20
commit f22c5c17b6
Failed to generate hash of commit
5 changed files with 66 additions and 50 deletions
Download patch file Download diff file Expand all files Collapse all files

17
docs/cli.md
View file

@ -6,7 +6,8 @@ This page describes how to setup and use the QMK CLI.
The QMK CLI makes building and working with QMK keyboards easier. We have provided a number of commands to help you work with QMK:
* `qmk compile-json`
* `qmk compile`
* `qmk doctor`
# Setup
@ -20,12 +21,18 @@ You may want to add this to your `.profile`, `.bash_profile`, `.zsh_profile`, or
# Commands
## `qmk compile-json`
## `qmk compile`
This command allows you to compile JSON files you have downloaded from <https://config.qmk.fm>.
This command allows you to compile firmware from any directory. You can compile JSON exports from <https://config.qmk.fm> or compile keymaps in the repo.
**Usage**:
**Usage for Configurator Exports**:
```
qmk compile-json mine.json
qmk compile <configuratorExport.json>
```
**Usage for Keymaps**:
```
qmk compile -kb <keyboard_name> -km <keymap_name>
```