diff options
| author | skullydazed <skullydazed@users.noreply.github.com> | 2019-08-25 11:58:24 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-08-25 11:58:24 -0700 |
| commit | f22c5c17b6fe069bec1241262a1c27eb89d3d3af (patch) | |
| tree | e584607eec6685d7a564ac8e15ffa7bc217dc90e /docs | |
| parent | c289a4cb2044c618257ec1e426ccf9c6db8fbf66 (diff) | |
| download | firmware-f22c5c17b6fe069bec1241262a1c27eb89d3d3af.tar.gz firmware-f22c5c17b6fe069bec1241262a1c27eb89d3d3af.tar.bz2 firmware-f22c5c17b6fe069bec1241262a1c27eb89d3d3af.zip | |
Refactor `qmk compile-json` to `qmk compile` (#6592)
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/cli.md | 17 |
1 files changed, 12 insertions, 5 deletions
diff --git a/docs/cli.md b/docs/cli.md index 0365f2c9c..1843f42cd 100644 --- a/docs/cli.md +++ b/docs/cli.md @@ -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> ``` |