summaryrefslogtreecommitdiffstats
path: root/quantum/template/base/keyboard.h
diff options
context:
space:
mode:
authorfauxpark <fauxpark@gmail.com>2019-10-10 21:48:37 +1100
committerJoel Challis <git@zvecr.com>2019-10-10 11:48:37 +0100
commited1bf3afa25d7e7674df7e8618dfaf243de3058b (patch)
treecfe0e4331b8f00d09706dd0aaa8fef2cac3f61d7 /quantum/template/base/keyboard.h
parent528ddb79871b76d026c4b2ca8b1debf9feb1e751 (diff)
Prevent clang-format messing up placeholder tokens within keyboard templates (#6790)
* Use .template file extension for keyboard template files * Filter out .template files completely before passing to clang-format * Undo file extension stuff; just ignore quantum/template dir
Diffstat (limited to 'quantum/template/base/keyboard.h')
-rw-r--r--quantum/template/base/keyboard.h35
1 files changed, 35 insertions, 0 deletions
diff --git a/quantum/template/base/keyboard.h b/quantum/template/base/keyboard.h
new file mode 100644
index 0000000000..2e531b1fd4
--- /dev/null
+++ b/quantum/template/base/keyboard.h
@@ -0,0 +1,35 @@
+/* Copyright %YEAR% %YOUR_NAME%
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+#pragma once
+
+#include "quantum.h"
+
+/* 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 \
+) \
+{ \
+ { k00, k01, k02 }, \
+ { k10, KC_NO, k11 }, \
+}