qmk_firmware

QMK firmware for my keyboards (Corne, Sweep Ferris) and trackball (Ploopy Adept)
Log | Files | Refs | Submodules | LICENSE

configurator_step_by_step.md (3015B)

      1 # QMK Configurator: Step by Step
      2 
      3 This page describes the steps for building your firmware in QMK Configurator.
      4 
      5 ## Step 1: Select Your Keyboard
      6 
      7 Click the drop down box and select the keyboard you want to create a keymap for.
      8 
      9 ::: tip
     10 If your keyboard has several versions, make sure you select the correct one.
     11 :::
     12 
     13 I'll say that again because it's important:
     14 
     15 ::: warning
     16 **MAKE SURE YOU SELECT THE RIGHT VERSION!**
     17 :::
     18 
     19 Unfortunately if your keyboard has been advertised to be powered by QMK but is not in the list, you will **not** be able to use Configurator to customize your keyboard.
     20 
     21 Chances are a developer hasn't gotten round to adding support or we haven't had a chance to merge it in yet. If there is no active [Pull Request](https://github.com/qmk/qmk_firmware/pulls?q=is%3Aopen+is%3Apr+label%3Akeyboard), contact the manufacturer and encourage them to add support.
     22 
     23 ## Step 2: Select Your Keyboard Layout
     24 
     25 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.
     26 
     27 ::: warning
     28 Sometimes there isn't a layout that supports your exact build. In that case select `LAYOUT_all`.
     29 :::
     30 
     31 ## Step 3: Name Your Keymap
     32 
     33 Call this keymap what you want.
     34 
     35 ::: tip
     36 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.
     37 :::
     38 
     39 ## Step 4: Define Your Keymap
     40 
     41 Keycode Entry is accomplished in one of 3 ways:
     42 
     43 1. Drag and drop
     44 2. Clicking on an empty spot on the layout, then clicking the keycode you desire
     45 3. Clicking on an empty spot on the layout, then pressing the physical key on your keyboard
     46 
     47 ::: tip
     48 Hover your mouse over a key and a short blurb will tell you what that keycode does. For a more verbose description please see:
     49 :::
     50 
     51 * [Basic Keycode Reference](keycodes_basic)
     52 * [Advanced Keycode Reference](feature_advanced_keycodes)
     53 
     54 ::: warning
     55 If your selected layout doesn't match your physical build leave the unused keys blank. If you're not sure which key is in use, for example you have a one backspace key but `LAYOUT_all` has 2 keys, put the same keycode in both locations.
     56 :::
     57 
     58 ## Step 5: Save Your Keymap for Future Changes
     59 
     60 When you're satisfied with your keymap or just want to work on it later, press the `Download this QMK Keymap JSON File` button. It will save your keymap to your computer. You can then load this .json file in the future by pressing the `Upload a QMK Keymap JSON File` button.
     61 
     62 ::: warning
     63 **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.
     64 :::
     65 
     66 ## Step 6: Compile Your Firmware File
     67 
     68 Press the green `Compile` button.
     69 
     70 When the compilation is done, you will be able to press the green `Download Firmware` button.
     71 
     72 ## Next steps: Flashing Your Keyboard
     73 
     74 Please refer to [Flashing Firmware](newbs_flashing).