diff options
| author | Joel Challis <git@zvecr.com> | 2022-02-08 19:03:30 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-02-09 06:03:30 +1100 |
| commit | 2e279f1b889a59156f30524cc83358f64ee53287 (patch) | |
| tree | be7b7fc6718f2401bbca1820d043e24ddf194c77 /data/templates/avr/readme.md | |
| parent | a239051c4a4779767059140892144dedea09aaf2 (diff) | |
Initial pass at data driven new-keyboard subcommand (#12795)
* Initial pass at a data driven keyboard subcommand
* format
* lint
* Handle bootloader now its mandatory
Diffstat (limited to 'data/templates/avr/readme.md')
| -rw-r--r-- | data/templates/avr/readme.md | 27 |
1 files changed, 0 insertions, 27 deletions
diff --git a/data/templates/avr/readme.md b/data/templates/avr/readme.md deleted file mode 100644 index 207850e065..0000000000 --- a/data/templates/avr/readme.md +++ /dev/null @@ -1,27 +0,0 @@ -# %(KEYBOARD)s - - - -*A short description of the keyboard/project* - -* Keyboard Maintainer: [%(YOUR_NAME)s](https://github.com/%(USER_NAME)s) -* 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)s:default - -Flashing example for this keyboard: - - make %(KEYBOARD)s:default:flash - -See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). - -## Bootloader - -Enter the bootloader in 3 ways: - -* **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard -* **Physical reset button**: Briefly press the button on the back of the PCB - some may have pads you must short instead -* **Keycode in layout**: Press the key mapped to `RESET` if it is available |