summaryrefslogtreecommitdiff
path: root/data/templates/base
diff options
context:
space:
mode:
authorJoel Challis <git@zvecr.com>2021-08-24 17:07:11 +0100
committerGitHub <noreply@github.com>2021-08-24 17:07:11 +0100
commit2cade3a48300e0709f8aec68602faf90947b6738 (patch)
tree20d4e05ccb92ebf35c7aa3ab281590302e9befa9 /data/templates/base
parent2827a3cf754c2eaca37a0d44a5901741f1855414 (diff)
Align some quantum sub-directories (#14134)
* Misc folder tidy * Review comments * Remove redundant entry
Diffstat (limited to 'data/templates/base')
-rw-r--r--data/templates/base/info.json19
-rw-r--r--data/templates/base/keyboard.c17
-rw-r--r--data/templates/base/keyboard.h35
-rw-r--r--data/templates/base/keymaps/default/keymap.c62
-rw-r--r--data/templates/base/keymaps/default/readme.md1
5 files changed, 134 insertions, 0 deletions
diff --git a/data/templates/base/info.json b/data/templates/base/info.json
new file mode 100644
index 0000000000..af14d87996
--- /dev/null
+++ b/data/templates/base/info.json
@@ -0,0 +1,19 @@
+{
+ "keyboard_name": "%KEYBOARD%",
+ "url": "",
+ "maintainer": "%YOUR_NAME%",
+ "width": 3,
+ "height": 2,
+ "layouts": {
+ "LAYOUT": {
+ "layout": [
+ {"label": "k00", "x": 0, "y": 0},
+ {"label": "k01", "x": 1, "y": 0},
+ {"label": "k02", "x": 2, "y": 0},
+
+ {"label": "k10", "x": 0, "y": 1, "w": 1.5},
+ {"label": "k12", "x": 1.5, "y": 1, "w": 1.5}
+ ]
+ }
+ }
+}
diff --git a/data/templates/base/keyboard.c b/data/templates/base/keyboard.c
new file mode 100644
index 0000000000..f69ae16ede
--- /dev/null
+++ b/data/templates/base/keyboard.c
@@ -0,0 +1,17 @@
+/* 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/>.
+ */
+
+#include "%KEYBOARD%.h"
diff --git a/data/templates/base/keyboard.h b/data/templates/base/keyboard.h
new file mode 100644
index 0000000000..bd2e88d12b
--- /dev/null
+++ b/data/templates/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 is 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, k12 \
+) { \
+ { k00, k01, k02 }, \
+ { k10, KC_NO, k12 } \
+}
diff --git a/data/templates/base/keymaps/default/keymap.c b/data/templates/base/keymaps/default/keymap.c
new file mode 100644
index 0000000000..d8020ab3e3
--- /dev/null
+++ b/data/templates/base/keymaps/default/keymap.c
@@ -0,0 +1,62 @@
+/* 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/>.
+ */
+#include QMK_KEYBOARD_H
+
+// Defines names for use in layer keycodes and the keymap
+enum layer_names {
+ _BASE,
+ _FN
+};
+
+// Defines the keycodes used by our macros in process_record_user
+enum custom_keycodes {
+ QMKBEST = SAFE_RANGE,
+ QMKURL
+};
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+ /* Base */
+ [_BASE] = LAYOUT(
+ KC_A, KC_1, MO(_FN),
+ KC_TAB, KC_SPC
+ ),
+ [_FN] = LAYOUT(
+ QMKBEST, QMKURL, _______,
+ RESET, XXXXXXX
+ )
+};
+
+bool process_record_user(uint16_t keycode, keyrecord_t *record) {
+ switch (keycode) {
+ case QMKBEST:
+ if (record->event.pressed) {
+ // when keycode QMKBEST is pressed
+ SEND_STRING("QMK is the best thing ever!");
+ } else {
+ // when keycode QMKBEST is released
+ }
+ break;
+ case QMKURL:
+ if (record->event.pressed) {
+ // when keycode QMKURL is pressed
+ SEND_STRING("https://qmk.fm/\n");
+ } else {
+ // when keycode QMKURL is released
+ }
+ break;
+ }
+ return true;
+}
diff --git a/data/templates/base/keymaps/default/readme.md b/data/templates/base/keymaps/default/readme.md
new file mode 100644
index 0000000000..e052ed80f1
--- /dev/null
+++ b/data/templates/base/keymaps/default/readme.md
@@ -0,0 +1 @@
+# The default keymap for %KEYBOARD%