diff options
| author | James Young <xxiinophobia@yahoo.com> | 2020-02-25 17:22:05 -0800 |
|---|---|---|
| committer | skullydazed <skullydazed@users.noreply.github.com> | 2020-03-05 16:00:10 -0800 |
| commit | d5f34c48103f09cb3cadfc8ee7ae0a760c158ebb (patch) | |
| tree | 312220f2751e444dba3864de8a70d29a5ec98cda /docs/configurator_step_by_step.md | |
| parent | 503b52652c82add2daf84112c745e3e744c10e77 (diff) | |
| download | qmk_firmware-d5f34c48103f09cb3cadfc8ee7ae0a760c158ebb.tar.gz qmk_firmware-d5f34c48103f09cb3cadfc8ee7ae0a760c158ebb.zip | |
Polish Configurator section
Diffstat (limited to 'docs/configurator_step_by_step.md')
| -rw-r--r-- | docs/configurator_step_by_step.md | 16 |
1 files changed, 8 insertions, 8 deletions
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 | ||
| 3 | This page describes the steps for building your firmware in QMK Configurator. | 3 | This 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 | ||
| 7 | Click the drop down box and select the keyboard you want to create a keymap for. | 7 | Click 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 | ||
| 15 | 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? --> | 15 | 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? --> |
| 16 | 16 | ||
| 17 | ## Step 2: Select your keyboard layout | 17 | ## Step 2: Select Your Keyboard Layout |
| 18 | 18 | ||
| 19 | 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. | 19 | 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. |
| 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 | ||
| 31 | Keycode Entry is accomplished in one of 3 ways. | 31 | Keycode Entry is accomplished in one of 3 ways: |
| 32 | 32 | ||
| 33 | 1. Drag and drop | 33 | 1. Drag and drop |
| 34 | 2. Clicking on an empty spot on the layout and clicking the keycode you desire | 34 | 2. Clicking on an empty spot on the layout, then clicking the keycode you desire |
| 35 | 3. Clicking on an empty spot on the layout, pressing the physical key on your keyboard. | 35 | 3. 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 | ||
| 52 | Press the green `Compile` button. | 52 | Press 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 | ||
| 58 | Please refer to [Flashing Firmware](newbs_flashing.md) | 58 | Please refer to [Flashing Firmware](newbs_flashing.md). |