2db4ad21 |
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 |
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](http://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](http://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](http://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](http://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 | |
800ec55d |
37 | make planck/rev4:default |
2db4ad21 |
38 | |
8454fa5e |
39 | See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). |
2db4ad21 |
40 | ``` |
41 | |
42 | There needs to be two spaces at the end of the `Keyboard Maintainer` and `Hardware Supported` lines for it to render correctly with Markdown. |