summaryrefslogtreecommitdiff
path: root/data/templates/keyboard
diff options
context:
space:
mode:
authorJoel Challis <git@zvecr.com>2022-02-08 19:03:30 +0000
committerGitHub <noreply@github.com>2022-02-09 06:03:30 +1100
commit2e279f1b889a59156f30524cc83358f64ee53287 (patch)
treebe7b7fc6718f2401bbca1820d043e24ddf194c77 /data/templates/keyboard
parenta239051c4a4779767059140892144dedea09aaf2 (diff)
downloadqmk_firmware-2e279f1b889a59156f30524cc83358f64ee53287.tar.gz
qmk_firmware-2e279f1b889a59156f30524cc83358f64ee53287.zip
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/keyboard')
-rw-r--r--data/templates/keyboard/info.json24
-rw-r--r--data/templates/keyboard/readme.md27
-rw-r--r--data/templates/keyboard/rules.mk1
3 files changed, 52 insertions, 0 deletions
diff --git a/data/templates/keyboard/info.json b/data/templates/keyboard/info.json
new file mode 100644
index 0000000000..92718faf3a
--- /dev/null
+++ b/data/templates/keyboard/info.json
@@ -0,0 +1,24 @@
+{
+ "keyboard_name": "%KEYBOARD%",
+ "maintainer": "%USER_NAME%",
+ "processor": "%MCU%",
+ "bootloader": "%BOOTLOADER%",
+ "diode_direction": "COL2ROW",
+ "matrix_pins": {
+ "cols": ["C2"],
+ "rows": ["D1"]
+ },
+ "usb": {
+ "vid": "0xFEED",
+ "pid": "0x0000",
+ "device_ver": "0x0001"
+ },
+ "features": {
+ "bootmagic_lite": true,
+ "command": false,
+ "console": false,
+ "extrakey": true,
+ "mousekey": true,
+ "nkro": true
+ }
+} \ No newline at end of file
diff --git a/data/templates/keyboard/readme.md b/data/templates/keyboard/readme.md
new file mode 100644
index 0000000000..ca703c53f0
--- /dev/null
+++ b/data/templates/keyboard/readme.md
@@ -0,0 +1,27 @@
+# %KEYBOARD%
+
+![%KEYBOARD%](imgur.com image replace me!)
+
+*A short description of the keyboard/project*
+
+* Keyboard Maintainer: [%REAL_NAME%](https://github.com/%USER_NAME%)
+* 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%:default
+
+Flashing example for this keyboard:
+
+ make %KEYBOARD%: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
diff --git a/data/templates/keyboard/rules.mk b/data/templates/keyboard/rules.mk
new file mode 100644
index 0000000000..6e7633bfe0
--- /dev/null
+++ b/data/templates/keyboard/rules.mk
@@ -0,0 +1 @@
+# This file intentionally left blank