aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--docs/cli.md3
-rw-r--r--docs/keycodes.md4
-rw-r--r--docs/newbs_building_firmware_configurator.md48
-rw-r--r--docs/support.md8
4 files changed, 31 insertions, 32 deletions
diff --git a/docs/cli.md b/docs/cli.md
index 7c3effcc0..eda365d87 100644
--- a/docs/cli.md
+++ b/docs/cli.md
@@ -167,8 +167,7 @@ $ qmk compile -kb dz60
167## `qmk flash` 167## `qmk flash`
168 168
169This command is similar to `qmk compile`, but can also target a bootloader. The bootloader is optional, and is set to `:flash` by default. 169This command is similar to `qmk compile`, but can also target a bootloader. The bootloader is optional, and is set to `:flash` by default.
170To specify a different bootloader, use `-bl <bootloader>`. Visit <https://docs.qmk.fm/#/flashing> 170To specify a different bootloader, use `-bl <bootloader>`. Visit the [Flashing Firmware](flashing.md) guide for more details of the available bootloaders.
171for more details of the available bootloaders.
172 171
173**Usage for Configurator Exports**: 172**Usage for Configurator Exports**:
174 173
diff --git a/docs/keycodes.md b/docs/keycodes.md
index c151c5700..91051e716 100644
--- a/docs/keycodes.md
+++ b/docs/keycodes.md
@@ -312,8 +312,8 @@ This is a reference only. Each group of keys links to the page documenting their
312|----------------|----------------------------------------------------------------------------------| 312|----------------|----------------------------------------------------------------------------------|
313|`DF(layer)` |Set the base (default) layer | 313|`DF(layer)` |Set the base (default) layer |
314|`MO(layer)` |Momentarily turn on `layer` when pressed (requires `KC_TRNS` on destination layer)| 314|`MO(layer)` |Momentarily turn on `layer` when pressed (requires `KC_TRNS` on destination layer)|
315|`OSL(layer)` |Momentarily activates `layer` until a key is pressed. See [One Shot Keys](https://docs.qmk.fm/#/feature_advanced_keycodes?id=one-shot-keys) for details. | 315|`OSL(layer)` |Momentarily activates `layer` until a key is pressed. See [One Shot Keys](feature_advanced_keycodes#one-shot-keys) for details. |
316|`LM(layer, mod)`|Momentarily turn on `layer` (like MO) with `mod` active as well. Where `mod` is a mods_bit. Mods can be viewed [here](https://docs.qmk.fm/#/feature_advanced_keycodes?id=mod-tap). Example Implementation: `LM(LAYER_1, MOD_LALT)`| 316|`LM(layer, mod)`|Momentarily turn on `layer` (like MO) with `mod` active as well. Where `mod` is a mods_bit. Mods can be viewed [here](feature_advanced_keycodes#mod-tap). Example Implementation: `LM(LAYER_1, MOD_LALT)`|
317|`LT(layer, kc)` |Turn on `layer` when held, `kc` when tapped | 317|`LT(layer, kc)` |Turn on `layer` when held, `kc` when tapped |
318|`TG(layer)` |Toggle `layer` on or off | 318|`TG(layer)` |Toggle `layer` on or off |
319|`TO(layer)` |Turns on `layer` and turns off all other layers, except the default layer | 319|`TO(layer)` |Turns on `layer` and turns off all other layers, except the default layer |
diff --git a/docs/newbs_building_firmware_configurator.md b/docs/newbs_building_firmware_configurator.md
index becceb669..472b30cac 100644
--- a/docs/newbs_building_firmware_configurator.md
+++ b/docs/newbs_building_firmware_configurator.md
@@ -1,51 +1,51 @@
1# QMK Configurator 1# QMK Configurator
2 2
3The [QMK Configurator](https://config.qmk.fm) is an online graphical user interface that generates QMK Firmware hex files. 3The [QMK Configurator](https://config.qmk.fm) is an online graphical user interface that generates QMK Firmware hex files.
4 4
5?> **Please follow these steps in order.** 5?> **Please follow these steps in order.**
6 6
7Watch the [Video Tutorial](https://youtu.be/tx54jkRC9ZY) 7Watch the [Video Tutorial](https://youtu.be/tx54jkRC9ZY)
8 8
9The QMK Configurator works best with Chrome/Firefox. 9The QMK Configurator works best with Chrome/Firefox.
10 10
11 11
12!> **Files from other tools such as KLE, or kbfirmware will not be compatible with QMK Configurator. Do not load them, do not import them. QMK Configurator is a DIFFERENT tool. ** 12!> **Files from other tools such as KLE, or kbfirmware will not be compatible with QMK Configurator. Do not load them, do not import them. QMK Configurator is a DIFFERENT tool. **
13 13
14## Selecting your keyboard 14## Selecting your keyboard
15 15
16Click the drop down box and select the keyboard you want to create a keymap for. 16Click the drop down box and select the keyboard you want to create a keymap for.
17 17
18?> If your keyboard has several versions, make sure you select the correct one.** 18?> If your keyboard has several versions, make sure you select the correct one.**
19 19
20I'll say that again because it's important 20I'll say that again because it's important
21 21
22!> **MAKE SURE YOU SELECT THE RIGHT VERSION!** 22!> **MAKE SURE YOU SELECT THE RIGHT VERSION!**
23 23
24If your keyboard has been advertised to be powered by QMK but is not in the list, chances are a developer hasn't gotten to it yet or we haven't had a chance to merge it in yet. File an issue at [qmk_firmware](https://github.com/qmk/qmk_firmware/issues) requesting to support that particular keyboard, if there is no active [Pull Request](https://github.com/qmk/qmk_firmware/pulls?q=is%3Aopen+is%3Apr+label%3Akeyboard) for it. There are also QMK powered keyboards that are in their manufacturer's own github accounts. Double check for that as well. 24If your keyboard has been advertised to be powered by QMK but is not in the list, chances are a developer hasn't gotten to it yet or we haven't had a chance to merge it in yet. File an issue at [qmk_firmware](https://github.com/qmk/qmk_firmware/issues) requesting to support that particular keyboard, if there is no active [Pull Request](https://github.com/qmk/qmk_firmware/pulls?q=is%3Aopen+is%3Apr+label%3Akeyboard) for it. There are also QMK powered keyboards that are in their manufacturer's own github accounts. Double check for that as well.
25 25
26## Selecting your keyboard layout 26## Selecting your keyboard layout
27 27
28Choose the layout that best represents the keymap you want to create. Some keyboards do not have enough layouts or correct layouts defined yet. They will be supported in the future. 28Choose the layout that best represents the keymap you want to create. Some keyboards do not have enough layouts or correct layouts defined yet. They will be supported in the future.
29 29
30## Keymap Name 30## Keymap Name
31 31
32Call this keymap what you want. 32Call this keymap what you want.
33 33
34?> If you are running into issues when compiling, it may be worth changing this name, as it may already exist in the QMK Firmware repo. 34?> If you are running into issues when compiling, it may be worth changing this name, as it may already exist in the QMK Firmware repo.
35 35
36## Creating Your Keymap 36## Creating Your Keymap
37 37
38Keycode Entry is accomplished in 3 ways. 38Keycode Entry is accomplished in 3 ways.
391. Drag and dropping 391. Drag and dropping
402. Clicking on an empty spot on the layout and clicking the keycode you desire 402. Clicking on an empty spot on the layout and clicking the keycode you desire
413. Clicking on an empty spot on the layout, pressing the physical key on your keyboard. 413. Clicking on an empty spot on the layout, pressing the physical key on your keyboard.
42 42
43Hover your mouse over a key and a short blurb will tell you what that keycode does. For a more verbose description please see 43Hover your mouse over a key and a short blurb will tell you what that keycode does. For a more verbose description please see
44 44
45[Basic Keycode Reference](https://docs.qmk.fm/#/keycodes_basic) 45[Basic Keycode Reference](keycodes_basic.md)
46[Advanced Keycode Reference](https://docs.qmk.fm/#/feature_advanced_keycodes) 46[Advanced Keycode Reference](feature_advanced_keycodes.md)
47 47
48In the event that you can't find a layout that supports your keymap, for example three spots for spacebar, or two spots for backspace, or 2 spots for shift etc etc, Fill them ALL up. 48In the event that you can't find a layout that supports your keymap, for example three spots for spacebar, or two spots for backspace, or 2 spots for shift etc etc, Fill them ALL up.
49 49
50### Example: 50### Example:
51 51
@@ -57,21 +57,21 @@ In the event that you can't find a layout that supports your keymap, for example
57 57
581 spot for left shift and 1 spot for iso support: Fill them both with left shift 581 spot for left shift and 1 spot for iso support: Fill them both with left shift
59 59
605 spots, but only 4 keys: Guess and check or ask someone who has done it before. 605 spots, but only 4 keys: Guess and check or ask someone who has done it before.
61 61
62## Saving Your Keymap for Future Edits 62## Saving Your Keymap for Future Edits
63 63
64When you're satisfied with your keymap or just want to work on it later, press the `Export Keymap` button. It will save your keymap as the name you chose above appended with .json. 64When you're satisfied with your keymap or just want to work on it later, press the `Export Keymap` button. It will save your keymap as the name you chose above appended with .json.
65 65
66You can then load this .json file in the future by pressing the `Import Keymap` button. 66You can then load this .json file in the future by pressing the `Import Keymap` button.
67 67
68!> **CAUTION:** This is not the same type of .json file used for kbfirmware.com or any other tool. If you try to use this for those tools, or the .json from those tools with QMK Configurator, there is a chance your keyboard will **explode**. 68!> **CAUTION:** This is not the same type of .json file used for kbfirmware.com or any other tool. If you try to use this for those tools, or the .json from those tools with QMK Configurator, there is a chance your keyboard will **explode**.
69 69
70## Generating your firmware file 70## Generating your firmware file
71 71
72Press the green `Compile` button. 72Press the green `Compile` button.
73 73
74When the compilation is done, you will be able to press the green `Download Firmware` button. 74When the compilation is done, you will be able to press the green `Download Firmware` button.
75 75
76## Flashing Your Keyboard 76## Flashing Your Keyboard
77 77
@@ -83,9 +83,9 @@ Please refer to [Flashing Firmware](newbs_flashing.md)
83 83
84If the .json file was generated with QMK Configurator, congratulations you have stumbled upon a bug. File an issue at [qmk_configurator](https://github.com/qmk/qmk_configurator/issues) 84If the .json file was generated with QMK Configurator, congratulations you have stumbled upon a bug. File an issue at [qmk_configurator](https://github.com/qmk/qmk_configurator/issues)
85 85
86If not....how did you miss my big bold message at the top saying not to use other .json files? 86If not....how did you miss my big bold message at the top saying not to use other .json files?
87 87
88#### There are extra spaces in my layout? What do I do? 88#### There are extra spaces in my layout? What do I do?
89 89
90If you're referring to having three spots for space bar, the best course of action is to just fill them all with space bar. The same can be done for backspace and shifts 90If you're referring to having three spots for space bar, the best course of action is to just fill them all with space bar. The same can be done for backspace and shifts
91 91
@@ -93,12 +93,12 @@ If you're referring to having three spots for space bar, the best course of acti
93 93
94Please see 94Please see
95 95
96[Basic Keycode Reference](https://docs.qmk.fm/#/keycodes_basic) 96[Basic Keycode Reference](keycodes_basic.md)
97[Advanced Keycode Reference](https://docs.qmk.fm/#/feature_advanced_keycodes) 97[Advanced Keycode Reference](feature_advanced_keycodes.md)
98 98
99#### It won't compile 99#### It won't compile
100 100
101Please double check the other layers of your keymap to make sure there are no random keys present. 101Please double check the other layers of your keymap to make sure there are no random keys present.
102 102
103## Problems and Bugs 103## Problems and Bugs
104 104
diff --git a/docs/support.md b/docs/support.md
index 5c275b07e..d960992c3 100644
--- a/docs/support.md
+++ b/docs/support.md
@@ -6,13 +6,13 @@ Don't forget to read our [Code of Conduct](https://qmk.fm/coc/).
6 6
7## Help! I don't know where to start! 7## Help! I don't know where to start!
8 8
9If this is the case, then you should start with our [Newbs Guide](https://docs.qmk.fm/#/newbs). There is a lot of great info there, and that should cover everything you need to get started. 9If this is the case, then you should start with our [Newbs Guide](newbs.md). There is a lot of great info there, and that should cover everything you need to get started.
10 10
11If that's an issue, hop onto the [QMK Configurator](https://config.qmk.fm), as that will handle a majority of what you need there. 11If that's an issue, hop onto the [QMK Configurator](https://config.qmk.fm), as that will handle a majority of what you need there.
12 12
13## Help! I'm having issues flashing! 13## Help! I'm having issues flashing!
14 14
15First, head to the [Compiling/Flashing FAQ Page](https://docs.qmk.fm/#/faq_build). There is a good deal of info there, and you'll find a bunch of solutions to common issues there. 15First, head to the [Compiling/Flashing FAQ Page](faq_build.md). There is a good deal of info there, and you'll find a bunch of solutions to common issues there.
16 16
17## Help, I have an issue that isn't covered by the links above 17## Help, I have an issue that isn't covered by the links above
18 18
@@ -26,9 +26,9 @@ Then please open an [issue](https://github.com/qmk/qmk_firmware/issues/new), and
26 26
27## But `git` and `GitHub` are intimidating! 27## But `git` and `GitHub` are intimidating!
28 28
29Don't worry, we have some pretty nice [Guidelines](https://docs.qmk.fm/#/newbs_best_practices) on how to start using `git` and GitHub to make things easier to develop. 29Don't worry, we have some pretty nice [Guidelines](newbs_git_best_practices.md) on how to start using `git` and GitHub to make things easier to develop.
30 30
31Additionally, you can find additional `git` and GitHub related links [here](https://docs.qmk.fm/#/newbs_learn_more_resources). 31Additionally, you can find additional `git` and GitHub related links [here](newbs_learn_more_resources.md).
32 32
33## I have a Keyboard that I want to add support for 33## I have a Keyboard that I want to add support for
34 34