mirrors/opensteno_qmk
1
0
Fork 0
mirror of https://github.com/openstenoproject/qmk synced 2024-11-10 02:30:07 +00:00
Code Issues Projects Releases Packages Wiki Activity

Polish Configurator section

Browse source
This commit is contained in:
James Young 2020-02-25 17:22:05 -08:00 committed by skullydazed
parent 503b52652c
commit d5f34c4810
5 changed files with 30 additions and 25 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
docs/configurator_problems.md
View file

@ -1,3 +0,0 @@
# Problems and Bugs
We are always accepting customer requests and bug reports. Please file them at [qmk_configurator](https://github.com/qmk/qmk_configurator/issues)

16
docs/configurator_step_by_step.md
View file

@ -1,8 +1,8 @@
# Step by Step # QMK Configurator: Step by Step
This page describes the steps for building your firmware in QMK Configurator. This page describes the steps for building your firmware in QMK Configurator.
## Step 1: Select your keyboard ## Step 1: Select Your Keyboard
Click the drop down box and select the keyboard you want to create a keymap for. Click the drop down box and select the keyboard you want to create a keymap for.
@ -14,7 +14,7 @@ I'll say that again because it's important:
If 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? --> If 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? -->
## Step 2: Select your keyboard layout ## Step 2: Select Your Keyboard Layout
Choose 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. Choose 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.
@ -28,11 +28,11 @@ Call this keymap what you want.
## Step 4: Define Your Keymap ## Step 4: Define Your Keymap
Keycode Entry is accomplished in one of 3 ways. Keycode Entry is accomplished in one of 3 ways:
1. Drag and drop 1. Drag and drop
2. Clicking on an empty spot on the layout and clicking the keycode you desire 2. Clicking on an empty spot on the layout, then clicking the keycode you desire
3. Clicking on an empty spot on the layout, pressing the physical key on your keyboard. 3. Clicking on an empty spot on the layout, then pressing the physical key on your keyboard
?> Hover your mouse over a key and a short blurb will tell you what that keycode does. For a more verbose description please see: ?> Hover your mouse over a key and a short blurb will tell you what that keycode does. For a more verbose description please see:
@ -47,7 +47,7 @@ When you're satisfied with your keymap or just want to work on it later, press t
!> **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. !> **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.
## Step 6: Compile your firmware file ## Step 6: Compile Your Firmware File
Press the green `Compile` button. Press the green `Compile` button.
@ -55,4 +55,4 @@ When the compilation is done, you will be able to press the green `Download Firm
## Next steps: Flashing Your Keyboard ## Next steps: Flashing Your Keyboard
Please refer to [Flashing Firmware](newbs_flashing.md) Please refer to [Flashing Firmware](newbs_flashing.md).

12
docs/configurator_troubleshooting.md
View file

@ -2,15 +2,15 @@
## My .json file is not working ## My .json file is not working
If 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) If 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).
If not....how did you miss my big bold message at the top saying not to use other .json files? If not... how did you miss the big bold message at the top saying not to use other .json files?
## There are extra spaces in my layout? What do I do? ## There are extra spaces in my layout? What do I do?
If 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 If 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.
## What is the keycode for....... ## What is the keycode for...
Please see: Please see:
@ -20,3 +20,7 @@ Please see:
## It won't compile ## It won't compile
Please double check the other layers of your keymap to make sure there are no random keys present. Please double check the other layers of your keymap to make sure there are no random keys present.
## Problems and Bugs
We are always accepting customer requests and bug reports. Please file them at [qmk_configurator](https://github.com/qmk/qmk_configurator/issues).

4
docs/newbs_building_firmware_configurator.md
View file

@ -8,4 +8,6 @@ Watch the [Video Tutorial](https://www.youtube.com/watch?v=-imgglzDMdY). Many pe
The QMK Configurator works best with Chrome or Firefox. The QMK Configurator works best with Chrome or Firefox.
!> **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.** !> **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.**
Please refer to [QMK Configurator: Step by Step](configurator_step_by_step.md).

20
docs/reference_configurator_support.md
View file

@ -10,11 +10,11 @@ To understand how the Configurator understands keyboards, first one must underst
``` ```
|---------------| |---------------|
|NLk| / | * | - | |NLk| / | * | - |
|---+---+-------| |---+---+---+---|
|7 |8 |9 | + | |7 |8 |9 | + |
|---+---+---| │ |---+---+---| |
|4 |5 |6 | | |4 |5 |6 | |
|---+---+-------| |---+---+---+---|
|1 |2 |3 |Ent| |1 |2 |3 |Ent|
|-------+---| | |-------+---| |
|0 | . | | |0 | . | |
@ -130,18 +130,20 @@ Use the `keyboard_name` object to set the name of the keyboard. For instruction
The `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: The `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:
``` ```
┌ The name of the key. Not displayed in the Configurator. The name of the key. Not displayed in the Configurator.
│ ┌ The key's X-axis location, in key units from the |
│ │ keyboard's left edge. | The key's X-axis location, in key units from the
│ │ ┌ The key's Y-axis location, in key units from | | keyboard's left edge.
│ │ │ the keyboard's top (rear-facing) edge. | |
| | The key's Y-axis location, in key units from
| | | the keyboard's top (rear-facing) edge.
↓ ↓ ↓ ↓ ↓ ↓
{"label":"Num Lock", "x":0, "y":0}, {"label":"Num Lock", "x":0, "y":0},
``` ```
Some objects will also have `"w"` and `"h"` keys, which represent a key's width and height, respectively. Some objects will also have `"w"` and `"h"` keys, which represent a key's width and height, respectively.
?> For more on the `info.json` files, see [QMK Keyboard Guidelines: Keyboard Metadata](hardware_keyboard_guidelines.md?id=keyboard-metadata) ?> For more on the `info.json` files, see [`info.json` Format](reference_info_json.md).
## How the Configurator Programs Keys ## How the Configurator Programs Keys