diff options
author | Erovia <erovia@users.noreply.github.com> | 2019-10-13 19:07:22 +0200 |
---|---|---|
committer | skullydazed <skullydazed@users.noreply.github.com> | 2020-02-15 15:19:03 -0800 |
commit | 26f53d38d932a21be9edfc3d55e585c21050c3a2 (patch) | |
tree | f4d19abe22da554fe9a40928f6fc3eca6163e2ab /docs/cli.md | |
parent | f96085af3877a8c42d0767d13d47c239ce08ef0f (diff) | |
download | qmk_firmware-26f53d38d932a21be9edfc3d55e585c21050c3a2.tar.gz qmk_firmware-26f53d38d932a21be9edfc3d55e585c21050c3a2.zip |
Another major refactoring, add documentation
Move all useful functions to the qmk module and use the cli subcommand
as a wrapper around it.
Add both inline comments and documentation.
Diffstat (limited to 'docs/cli.md')
-rw-r--r-- | docs/cli.md | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/cli.md b/docs/cli.md index f1c158af4..f2b433fbb 100644 --- a/docs/cli.md +++ b/docs/cli.md | |||
@@ -252,6 +252,16 @@ This command lists all the keyboards currently defined in `qmk_firmware` | |||
252 | qmk list-keyboards | 252 | qmk list-keyboards |
253 | ``` | 253 | ``` |
254 | 254 | ||
255 | ## `qmk list_keymaps` | ||
256 | |||
257 | This command lists all the keymaps for a specified keyboard (and revision). | ||
258 | |||
259 | **Usage**: | ||
260 | |||
261 | ``` | ||
262 | qmk list_keymaps -kb planck/ez | ||
263 | ``` | ||
264 | |||
255 | ## `qmk new-keymap` | 265 | ## `qmk new-keymap` |
256 | 266 | ||
257 | This command creates a new keymap based on a keyboard's existing default keymap. | 267 | This command creates a new keymap based on a keyboard's existing default keymap. |