diff options
| author | Erez Zukerman <bulk@ezuk.org> | 2018-05-15 10:50:24 -0400 |
|---|---|---|
| committer | Erez Zukerman <bulk@ezuk.org> | 2018-05-15 10:50:24 -0400 |
| commit | 5272218ac9cff7ce5af8cfda9129dc03b7aafa49 (patch) | |
| tree | 61ad3987770684afd55cbdd12bca48a221d83713 /quantum/template/base/readme.md | |
| parent | 0592d23b74142a554c9e36d2da7bf525fbe3a4c0 (diff) | |
| parent | e41147da929afd15c1088226893cc02537650284 (diff) | |
Merge branch 'master' into hf/shinydox
Diffstat (limited to 'quantum/template/base/readme.md')
| -rw-r--r-- | quantum/template/base/readme.md | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/quantum/template/base/readme.md b/quantum/template/base/readme.md new file mode 100644 index 0000000000..d9349811d0 --- /dev/null +++ b/quantum/template/base/readme.md @@ -0,0 +1,15 @@ +# %KEYBOARD% + + + +A short description of the keyboard/project + +Keyboard Maintainer: [You](https://github.com/yourusername) +Hardware Supported: The PCBs, controllers supported +Hardware Availability: links to where you can find this hardware + +Make example for this keyboard (after setting up your build environment): + + make %KEYBOARD%: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.
\ No newline at end of file |