diff options
| author | Erovia <Erovia@users.noreply.github.com> | 2020-10-07 01:10:19 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-10-06 17:10:19 -0700 |
| commit | 058737f116b53116726f32175205b46e22396f86 (patch) | |
| tree | d84cecc2d1716d93b56b078a3f86eff14db13415 /docs/cli_commands.md | |
| parent | c9a06965c991a84ac76014d9791e439f88dfb957 (diff) | |
[CLI] Add c2json (#8817)
* Basic keymap parsing finally works * Add 'keymap.json' creation to the qmk.keymap module * Add tests and fix formatting * Fix/exclude flake8 errors * Convert keymap.c to valid keymap.json * Fix some errors * Add tests * Finalize keymap.json creation, add json template * Add docs * Move pygments to the standard requirements * Add support for nameless layers, fix tests * Fix things after rebase * Add missing 'keymap' value. * Fix missing layer numbers from advanced keycodes Buckwich noticed that if the advanced keycode / layer toggling key contains a number, it goes missing. Now we properly handle them. Thx for noticing! * Apply suggestions from code review * fixup tests Co-authored-by: Zach White <skullydazed@drpepper.org> Co-authored-by: skullY <skullydazed@gmail.com>
Diffstat (limited to 'docs/cli_commands.md')
| -rw-r--r-- | docs/cli_commands.md | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/cli_commands.md b/docs/cli_commands.md index bb0de3c0db..fe6f06632a 100644 --- a/docs/cli_commands.md +++ b/docs/cli_commands.md @@ -167,6 +167,17 @@ Creates a keymap.c from a QMK Configurator export. qmk json2c [-o OUTPUT] filename ``` +## `qmk c2json` + +Creates a keymap.json from a keymap.c. +**Note:** Parsing C source files is not easy, therefore this subcommand may not work your keymap. In some cases not using the C pre-processor helps. + +**Usage**: + +``` +qmk c2json [--no-cpp] [-o OUTPUT] filename +``` + ## `qmk list-keyboards` This command lists all the keyboards currently defined in `qmk_firmware` |