aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJames Young <xxiinophobia@yahoo.com>2020-02-25 17:22:05 -0800
committerskullydazed <skullydazed@users.noreply.github.com>2020-03-05 16:00:10 -0800
commitd5f34c48103f09cb3cadfc8ee7ae0a760c158ebb (patch)
tree312220f2751e444dba3864de8a70d29a5ec98cda
parent503b52652c82add2daf84112c745e3e744c10e77 (diff)
downloadqmk_firmware-d5f34c48103f09cb3cadfc8ee7ae0a760c158ebb.tar.gz
qmk_firmware-d5f34c48103f09cb3cadfc8ee7ae0a760c158ebb.zip
Polish Configurator section
-rw-r--r--docs/configurator_problems.md3
-rw-r--r--docs/configurator_step_by_step.md16
-rw-r--r--docs/configurator_troubleshooting.md12
-rw-r--r--docs/newbs_building_firmware_configurator.md4
-rw-r--r--docs/reference_configurator_support.md20
5 files changed, 30 insertions, 25 deletions
diff --git a/docs/configurator_problems.md b/docs/configurator_problems.md
deleted file mode 100644
index 5904b70ba..000000000
--- a/docs/configurator_problems.md
+++ /dev/null
@@ -1,3 +0,0 @@
1# Problems and Bugs
2
3We are always accepting customer requests and bug reports. Please file them at [qmk_configurator](https://github.com/qmk/qmk_configurator/issues)
diff --git a/docs/configurator_step_by_step.md b/docs/configurator_step_by_step.md
index 98e37a737..aee1d4e1f 100644
--- a/docs/configurator_step_by_step.md
+++ b/docs/configurator_step_by_step.md
@@ -1,8 +1,8 @@
1# Step by Step 1# QMK Configurator: Step by Step
2 2
3This page describes the steps for building your firmware in QMK Configurator. 3This page describes the steps for building your firmware in QMK Configurator.
4 4
5## Step 1: Select your keyboard 5## Step 1: Select Your Keyboard
6 6
7Click the drop down box and select the keyboard you want to create a keymap for. 7Click the drop down box and select the keyboard you want to create a keymap for.
8 8
@@ -14,7 +14,7 @@ I'll say that again because it's important:
14 14
15If 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. <!-- FIXME(skullydazed): This feels too wordy and I'm not sure we want to encourage these kinds of issues. Also, should we prompt them to bug the manufacutrer? --> 15If 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. <!-- FIXME(skullydazed): This feels too wordy and I'm not sure we want to encourage these kinds of issues. Also, should we prompt them to bug the manufacutrer? -->
16 16
17## Step 2: Select your keyboard layout 17## Step 2: Select Your Keyboard Layout
18 18
19Choose 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. 19Choose 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.
20 20
@@ -28,11 +28,11 @@ Call this keymap what you want.
28 28
29## Step 4: Define Your Keymap 29## Step 4: Define Your Keymap
30 30
31Keycode Entry is accomplished in one of 3 ways. 31Keycode Entry is accomplished in one of 3 ways:
32 32
331. Drag and drop 331. Drag and drop
342. Clicking on an empty spot on the layout and clicking the keycode you desire 342. Clicking on an empty spot on the layout, then clicking the keycode you desire
353. Clicking on an empty spot on the layout, pressing the physical key on your keyboard. 353. Clicking on an empty spot on the layout, then pressing the physical key on your keyboard
36 36
37?> Hover your mouse over a key and a short blurb will tell you what that keycode does. For a more verbose description please see: 37?> Hover your mouse over a key and a short blurb will tell you what that keycode does. For a more verbose description please see:
38 38
@@ -47,7 +47,7 @@ When you're satisfied with your keymap or just want to work on it later, press t
47 47
48!> **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, you will encounter problems. 48!> **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, you will encounter problems.
49 49
50## Step 6: Compile your firmware file 50## Step 6: Compile Your Firmware File
51 51
52Press the green `Compile` button. 52Press the green `Compile` button.
53 53
@@ -55,4 +55,4 @@ When the compilation is done, you will be able to press the green `Download Firm
55 55
56## Next steps: Flashing Your Keyboard 56## Next steps: Flashing Your Keyboard
57 57
58Please refer to [Flashing Firmware](newbs_flashing.md) 58Please refer to [Flashing Firmware](newbs_flashing.md).
diff --git a/docs/configurator_troubleshooting.md b/docs/configurator_troubleshooting.md
index 0d013af29..80b9713b6 100644
--- a/docs/configurator_troubleshooting.md
+++ b/docs/configurator_troubleshooting.md
@@ -2,15 +2,15 @@
2 2
3## My .json file is not working 3## My .json file is not working
4 4
5If 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) 5If 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).
6 6
7If not....how did you miss my big bold message at the top saying not to use other .json files? 7If not... how did you miss the big bold message at the top saying not to use other .json files?
8 8
9## There are extra spaces in my layout? What do I do? 9## There are extra spaces in my layout? What do I do?
10 10
11If 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 11If you're referring to having three spots for space bar, the best course of action is to just fill them all with Space. The same can be done for Backspace and Shift keys.
12 12
13## What is the keycode for....... 13## What is the keycode for...
14 14
15Please see: 15Please see:
16 16
@@ -20,3 +20,7 @@ Please see:
20## It won't compile 20## It won't compile
21 21
22Please double check the other layers of your keymap to make sure there are no random keys present. 22Please double check the other layers of your keymap to make sure there are no random keys present.
23
24## Problems and Bugs
25
26We are always accepting customer requests and bug reports. Please file them at [qmk_configurator](https://github.com/qmk/qmk_configurator/issues).
diff --git a/docs/newbs_building_firmware_configurator.md b/docs/newbs_building_firmware_configurator.md
index 46e564eb1..ac702f391 100644
--- a/docs/newbs_building_firmware_configurator.md
+++ b/docs/newbs_building_firmware_configurator.md
@@ -8,4 +8,6 @@ Watch the [Video Tutorial](https://www.youtube.com/watch?v=-imgglzDMdY). Many pe
8 8
9The QMK Configurator works best with Chrome or Firefox. 9The QMK Configurator works best with Chrome or Firefox.
10 10
11!> **Note: 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.** 11!> **Note: Files from other tools such as Keyboard Layout Editor (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
13Please refer to [QMK Configurator: Step by Step](configurator_step_by_step.md).
diff --git a/docs/reference_configurator_support.md b/docs/reference_configurator_support.md
index 58c1a2d20..88676ba97 100644
--- a/docs/reference_configurator_support.md
+++ b/docs/reference_configurator_support.md
@@ -10,11 +10,11 @@ To understand how the Configurator understands keyboards, first one must underst
10``` 10```
11|---------------| 11|---------------|
12|NLk| / | * | - | 12|NLk| / | * | - |
13|---+---+-------| 13|---+---+---+---|
14|7 |8 |9 | + | 14|7 |8 |9 | + |
15|---+---+---| 15|---+---+---| |
16|4 |5 |6 | | 16|4 |5 |6 | |
17|---+---+-------| 17|---+---+---+---|
18|1 |2 |3 |Ent| 18|1 |2 |3 |Ent|
19|-------+---| | 19|-------+---| |
20|0 | . | | 20|0 | . | |
@@ -130,18 +130,20 @@ Use the `keyboard_name` object to set the name of the keyboard. For instruction
130The `layouts` object contains the data that represents the physical layout of the keyboard. It has an object `LAYOUT`, which needs to match the name of our layout macro from `numpad.h`. The `LAYOUT` object itself has an object named `layout`, which contains one JSON object for each physical key on our keyboard, formatted as follows: 130The `layouts` object contains the data that represents the physical layout of the keyboard. It has an object `LAYOUT`, which needs to match the name of our layout macro from `numpad.h`. The `LAYOUT` object itself has an object named `layout`, which contains one JSON object for each physical key on our keyboard, formatted as follows:
131 131
132``` 132```
133 ┌ The name of the key. Not displayed in the Configurator. 133 The name of the key. Not displayed in the Configurator.
134 │ ┌ The key's X-axis location, in key units from the 134 |
135 │ │ keyboard's left edge. 135 | The key's X-axis location, in key units from the
136 │ │ ┌ The key's Y-axis location, in key units from 136 | | keyboard's left edge.
137 │ │ │ the keyboard's top (rear-facing) edge. 137 | |
138 | | The key's Y-axis location, in key units from
139 | | | the keyboard's top (rear-facing) edge.
138 ↓ ↓ ↓ 140 ↓ ↓ ↓
139{"label":"Num Lock", "x":0, "y":0}, 141{"label":"Num Lock", "x":0, "y":0},
140``` 142```
141 143
142Some objects will also have `"w"` and `"h"` keys, which represent a key's width and height, respectively. 144Some objects will also have `"w"` and `"h"` keys, which represent a key's width and height, respectively.
143 145
144?> For more on the `info.json` files, see [QMK Keyboard Guidelines: Keyboard Metadata](hardware_keyboard_guidelines.md?id=keyboard-metadata) 146?> For more on the `info.json` files, see [`info.json` Format](reference_info_json.md).
145 147
146 148
147## How the Configurator Programs Keys 149## How the Configurator Programs Keys