diff options
Diffstat (limited to 'docs/documentation_templates.md')
| -rw-r--r-- | docs/documentation_templates.md | 42 |
1 files changed, 0 insertions, 42 deletions
diff --git a/docs/documentation_templates.md b/docs/documentation_templates.md deleted file mode 100644 index ba3830b64c..0000000000 --- a/docs/documentation_templates.md +++ /dev/null @@ -1,42 +0,0 @@ -# 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 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). -``` - -There needs to be two spaces at the end of the `Keyboard Maintainer` and `Hardware Supported` lines for it to render correctly with Markdown. |