summaryrefslogtreecommitdiff
path: root/quantum/template/ps2avrgb/template.h
diff options
context:
space:
mode:
authornoroadsleft <18669334+noroadsleft@users.noreply.github.com>2018-08-29 10:57:30 -0700
committerDrashna Jaelre <drashna@live.com>2018-08-29 10:57:30 -0700
commit836efb50c6fa1be9e3189242479e7ae5bc2b3f38 (patch)
tree45fb2e7ea137df978eb25068e0a60860f554ce20 /quantum/template/ps2avrgb/template.h
parent74f2f855a330899bb078b1a1ba433368e0e05ea6 (diff)
downloadqmk_firmware-836efb50c6fa1be9e3189242479e7ae5bc2b3f38.tar.gz
qmk_firmware-836efb50c6fa1be9e3189242479e7ae5bc2b3f38.zip
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/template.h')
-rw-r--r--quantum/template/ps2avrgb/template.h12
1 files changed, 8 insertions, 4 deletions
diff --git a/quantum/template/ps2avrgb/template.h b/quantum/template/ps2avrgb/template.h
index c3924ee71f..b4d6f46624 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 \