quantum/template/base/readme.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

# %KEYBOARD%

![%KEYBOARD%](imgur.com image replace me!)

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.