qmk_firmware

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

documentation_templates.md (2183B)

      1 # Documentation Templates
      2 
      3 This page documents the templates you should use when submitting new Keymaps and Keyboards to QMK.
      4 
      5 ## Keymap `readme.md` Template {#keyboard-readmemd-template}
      6 
      7 Most keymaps have an image depicting the layout. You can use [Keyboard Layout Editor](http://keyboard-layout-editor.com) to create an image. Upload it to [Imgur](https://imgur.com) or another hosting service, please do not include images in your Pull Request.
      8 
      9 Below the image you should write a short description to help people understand your keymap.
     10 
     11 ```
     12 ![Clueboard Layout Image](https://i.imgur.com/7Capi8W.png)
     13 
     14 # Default Clueboard Layout
     15 
     16 This is the default layout that comes flashed on every Clueboard. For the most
     17 part it's a straightforward and easy to follow layout. The only unusual key is
     18 the key in the upper left, which sends Escape normally, but Grave when any of
     19 the Ctrl, Alt, or GUI modifiers are held down.
     20 ```
     21 
     22 ## Keyboard `readme.md` Template
     23 
     24 ```
     25 # Planck
     26 
     27 ![Planck](https://i.imgur.com/q2M3uEU.jpg)
     28 
     29 A compact 40% (12x4) ortholinear keyboard kit made and sold by OLKB and Massdrop. [More info on qmk.fm](https://qmk.fm/planck/)
     30 
     31 * Keyboard Maintainer: [Jack Humbert](https://github.com/jackhumbert)
     32 * Hardware Supported: Planck PCB rev1, rev2, rev3, rev4, Teensy 2.0
     33 * Hardware Availability: [OLKB.com](https://olkb.com), [Massdrop](https://www.massdrop.com/buy/planck-mechanical-keyboard?mode=guest_open)
     34 
     35 Make example for this keyboard (after setting up your build environment):
     36 
     37     make planck/rev4:default
     38 
     39 Flashing example for this keyboard:
     40 
     41     make planck/rev4:default:flash
     42 
     43 See the [build environment setup](getting_started_build_tools) and the [make instructions](getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](newbs).
     44 
     45 ## Bootloader
     46 
     47 Enter the bootloader in 3 ways:
     48 
     49 * **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard
     50 * **Physical reset button**: Briefly press the button on the back of the PCB - some may have pads you must short instead
     51 * **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available
     52 ```