diff options
| author | noroadsleft <18669334+noroadsleft@users.noreply.github.com> | 2018-08-29 19:57:30 +0200 |
|---|---|---|
| committer | Drashna Jaelre <drashna@live.com> | 2018-08-29 19:57:30 +0200 |
| commit | 836efb50c6fa1be9e3189242479e7ae5bc2b3f38 (patch) | |
| tree | 45fb2e7ea137df978eb25068e0a60860f554ce20 /quantum/template/ps2avrgb | |
| parent | 74f2f855a330899bb078b1a1ba433368e0e05ea6 (diff) | |
| download | qmk_firmware-836efb50c6fa1be9e3189242479e7ae5bc2b3f38.tar.gz qmk_firmware-836efb50c6fa1be9e3189242479e7ae5bc2b3f38.tar.xz | |
Updated templates for use by new_project.sh (#3783)
* template.h file cleanup
Reformatted the pre-macro comments as block comments.
Updated the ps2avrgb template comment to match the avr template's comment, which was more informative.
Deleted the line about the macro representing the Planck MIT layout, because the macro doesn't represent that layout anymore.
* base template keymap.c refactor
Deleted the deprecated TMK macro functions.
Defined two custom keycodes for use as macros by process_record_user.
process_record_user is now after the keymap and before matrix_init_user, where the deleted TMK functions were.
* Removed an extra " from macro command per @drashna
* Added BOOTLOADER rule to avr/rules.mk per @drashna
* Updated Bootloader sections per @drashna
* Updated links to docs at the bottom of both avr and ps2avrgb template readme.md files
Corrected the links to the Build Environment Setup and the Make Instructions docs.
Added direct link to the QMK Complete Newbs Guide.
Diffstat (limited to 'quantum/template/ps2avrgb')
| -rw-r--r-- | quantum/template/ps2avrgb/readme.md | 2 | ||||
| -rw-r--r-- | quantum/template/ps2avrgb/template.h | 12 |
2 files changed, 9 insertions, 5 deletions
diff --git a/quantum/template/ps2avrgb/readme.md b/quantum/template/ps2avrgb/readme.md index 1dcbe6e75..feec722a5 100644 --- a/quantum/template/ps2avrgb/readme.md +++ b/quantum/template/ps2avrgb/readme.md @@ -41,4 +41,4 @@ macOS: 4. Place your keyboard into reset. 5. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file. -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. +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). diff --git a/quantum/template/ps2avrgb/template.h b/quantum/template/ps2avrgb/template.h index c3924ee71..b4d6f4662 100644 --- a/quantum/template/ps2avrgb/template.h +++ b/quantum/template/ps2avrgb/template.h @@ -18,10 +18,14 @@ #include "quantum.h" -// This a shortcut to help you visually see your layout. -// The following is an example using the Planck MIT layout -// The first section contains all of the arguments -// The second converts the arguments into a two-dimensional array +/* This a shortcut to help you visually see your layout. + * + * The first section contains all of the arguments representing the physical + * layout of the board and position of the keys. + * + * The second converts the arguments into a two-dimensional array which + * represents the switch matrix. + */ #define LAYOUT( \ k00, k01, k02, \ k10, k11 \ |