diff options
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 000000000..d9349811d --- /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 |