diff options
| author | skullydazed <skullydazed@users.noreply.github.com> | 2017-10-11 21:07:15 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-10-11 21:07:15 +0200 |
| commit | 2db4ad2133c229740c1a703eb83ae40396797797 (patch) | |
| tree | 881db8bf3a6201a825e869eaebacd21c87c0189c /docs/documentation_templates.md | |
| parent | b3ad561b4ff549cce6965622c18af1336b47dbdc (diff) | |
| download | qmk_firmware-2db4ad2133c229740c1a703eb83ae40396797797.tar.gz qmk_firmware-2db4ad2133c229740c1a703eb83ae40396797797.tar.xz | |
Write a contributing guide. (#1827)
Diffstat (limited to 'docs/documentation_templates.md')
| -rw-r--r-- | docs/documentation_templates.md | 42 |
1 files changed, 42 insertions, 0 deletions
diff --git a/docs/documentation_templates.md b/docs/documentation_templates.md new file mode 100644 index 000000000..856a131a6 --- /dev/null +++ b/docs/documentation_templates.md @@ -0,0 +1,42 @@ +# Documentation Templates + +This page documents the templates you should use when submitting new Keymaps and Keyboards to QMK. + +## Keymap `readme.md` Template + +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. + +Below the image you should write a short description to help people understand your keymap. + +``` + + +# Default Clueboard Layout + +This is the default layout that comes flashed on every Clueboard. For the most +part it's a straightforward and easy to follow layout. The only unusual key is +the key in the upper left, which sends Escape normally, but Grave when any of +the Ctrl, Alt, or GUI modifiers are held down. +``` + +## Keyboard `readme.md` Template + +``` +# Planck + + + +A compact 40% (12x4) ortholinear keyboard kit made and sold by OLKB and Massdrop. [More info on qmk.fm](http://qmk.fm/planck/) + +Keyboard Maintainer: [Jack Humbert](https://github.com/jackhumbert) +Hardware Supported: Planck PCB rev1, rev2, rev3, rev4, Teensy 2.0 +Hardware Availability: [OLKB.com](https://olkb.com), [Massdrop](https://www.massdrop.com/buy/planck-mechanical-keyboard?mode=guest_open) + +Make example for this keyboard (after setting up your build environment): + + make planck-rev4-default + +See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) then the [make instructions](https://docs.qmk.fm/make_instructions.html) for more information. +``` + +There needs to be two spaces at the end of the `Keyboard Maintainer` and `Hardware Supported` lines for it to render correctly with Markdown. |