diff options
Diffstat (limited to 'docs/configurator_default_keymaps.md')
-rw-r--r-- | docs/configurator_default_keymaps.md | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/configurator_default_keymaps.md b/docs/configurator_default_keymaps.md index 30f9fa72f..c52342cf1 100644 --- a/docs/configurator_default_keymaps.md +++ b/docs/configurator_default_keymaps.md | |||
@@ -20,7 +20,7 @@ Keymaps in this directory require four key-value pairs: | |||
20 | 20 | ||
21 | Additionally, most keymaps contain a `commit` key. This key is not consumed by the API that back-stops QMK Configurator, but is used by Configurator's maintainers to tell which version of a keymap was used to create the JSON keymap in this repository. The value is the SHA of the last commit to modify a board's default `keymap.c` in the `qmk_firmware` repository. The SHA is found by checking out [the `master` branch of the `qmk/qmk_firmware` repository](https://github.com/qmk/qmk_firmware/tree/master/) and running `git log -1 --pretty=oneline -- keyboards/<keyboard>/keymaps/default/keymap.c` (use `keymap.json` if the keyboard in question has this file instead), which should return something similar to: | 21 | Additionally, most keymaps contain a `commit` key. This key is not consumed by the API that back-stops QMK Configurator, but is used by Configurator's maintainers to tell which version of a keymap was used to create the JSON keymap in this repository. The value is the SHA of the last commit to modify a board's default `keymap.c` in the `qmk_firmware` repository. The SHA is found by checking out [the `master` branch of the `qmk/qmk_firmware` repository](https://github.com/qmk/qmk_firmware/tree/master/) and running `git log -1 --pretty=oneline -- keyboards/<keyboard>/keymaps/default/keymap.c` (use `keymap.json` if the keyboard in question has this file instead), which should return something similar to: |
22 | 22 | ||
23 | ```shell | 23 | ``` |
24 | f14629ed1cd7c7ec9089604d64f29a99981558e8 Remove/migrate action_get_macro()s from default keymaps (#5625) | 24 | f14629ed1cd7c7ec9089604d64f29a99981558e8 Remove/migrate action_get_macro()s from default keymaps (#5625) |
25 | ``` | 25 | ``` |
26 | 26 | ||
@@ -31,7 +31,7 @@ In this example, `f14629ed1cd7c7ec9089604d64f29a99981558e8` is the value that sh | |||
31 | 31 | ||
32 | If one wished to add a default keymap for the H87a by Hineybush, one would run the `git log` command above against the H87a's default keymap in `qmk_firmware`: | 32 | If one wished to add a default keymap for the H87a by Hineybush, one would run the `git log` command above against the H87a's default keymap in `qmk_firmware`: |
33 | 33 | ||
34 | ```shell | 34 | ``` |
35 | user ~/qmk_firmware (master) | 35 | user ~/qmk_firmware (master) |
36 | $ git log -1 --pretty=oneline master -- keyboards/hineybush/h87a/keymaps/default/keymap.c | 36 | $ git log -1 --pretty=oneline master -- keyboards/hineybush/h87a/keymaps/default/keymap.c |
37 | ef8878fba5d3786e3f9c66436da63a560cd36ac9 Hineybush h87a lock indicators (#8237) | 37 | ef8878fba5d3786e3f9c66436da63a560cd36ac9 Hineybush h87a lock indicators (#8237) |