diff options
| author | MechMerlin <30334081+mechmerlin@users.noreply.github.com> | 2018-05-09 21:36:40 -0700 |
|---|---|---|
| committer | Jack Humbert <jack.humb@gmail.com> | 2018-05-10 00:36:40 -0400 |
| commit | 5346cb2d20100f2bbf35e8c8107ae272404f2198 (patch) | |
| tree | 9b330b1e75e40bec2f5b7ede35f0c39adc09a362 /quantum/template/base/readme.md | |
| parent | c89565cc3dda82642a0c6c839176602f05fc56f1 (diff) | |
| download | firmware-5346cb2d20100f2bbf35e8c8107ae272404f2198.tar.gz firmware-5346cb2d20100f2bbf35e8c8107ae272404f2198.tar.bz2 firmware-5346cb2d20100f2bbf35e8c8107ae272404f2198.zip | |
Support both AVR and ps2avrGB targets for new_project script (#2811)
* Stopping point at creating targets for new_project script
* Add second argument for target
* Add the ps2avrgb target
* consider the case where the firmware type target is not valid
* fix template files to be more generic
* Code cleanup
* Change variable name to be more descriptive
* make avr the default
* forgot to put the template files in
* Take out useless comments
* add usage info
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 |