quantum/template/readme.md

   1 # %KEYBOARD%
   2
   3 ![%KEYBOARD%](imgur.com image replace me!)
   4
   5 A short description of the keyboard/project
   6
   7 Keyboard Maintainer: [You](https://github.com/yourusername)
   8 Hardware Supported: The PCBs, controllers supported
   9 Hardware Availability: links to where you can find this hardware
  10
  11 Make example for this keyboard (after setting up your build environment):
  12
  13     make %KEYBOARD%:default
  14
  15 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.