summaryrefslogtreecommitdiffstats
path: root/keyboards/crkbd/r2g/readme.md
diff options
context:
space:
mode:
authorElliot Powell <32494740+e11i0t23@users.noreply.github.com>2021-12-14 07:49:34 +0000
committerGitHub <noreply@github.com>2021-12-14 18:49:34 +1100
commit970ede9a1c808fd54f3f1310f1b74a586d890747 (patch)
treec8c27800eb436a31d66981625ef2a3fbb7f49ca1 /keyboards/crkbd/r2g/readme.md
parent59a1495fbf949161ee5842aebe7774411b5c675b (diff)
Add support for the crkbd r2g by mechboards (#15283)
* r2g folder groundwork * Default mb keymap featuring mb logos * Migrate Oled to keyboard folder * Move rules configs to support config better * update readmes * Liscnece update * Update config and fix issues caused by redef errs * funciton name adjusts, define specific rgb modes * move default oled font to postconfig * update oled in line with develop merge * fix return value * Add some default rgb matrix defines * del ugfx * remove #include <stdio.h>
Diffstat (limited to 'keyboards/crkbd/r2g/readme.md')
-rw-r--r--keyboards/crkbd/r2g/readme.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/keyboards/crkbd/r2g/readme.md b/keyboards/crkbd/r2g/readme.md
new file mode 100644
index 0000000000..7a9db3845d
--- /dev/null
+++ b/keyboards/crkbd/r2g/readme.md
@@ -0,0 +1,28 @@
+# Corne R2G
+
+![r2g](https://cdn.shopify.com/s/files/1/0582/0242/3501/products/HelidoxCorneR2GPCB_1800x1800.png)
+
+An Eddition of the popular CRKBD featuring a full smd assembly
+
+Keyboard Maintainer: [e11i0t23](https://github.com/e11i0t23/), [Mechboards UK](https://mechboards.co.uk)
+Hardware Supported: CRKBD R2G PCB
+Hardware Availability: [Mechboards UK](https://mechboards.co.uk/products/helidox-corne-kit?variant=40391708213453)
+
+Make example for this keyboard (after setting up your build environment):
+
+```sh
+make crkbd/r2g:mb_via
+```
+
+Flash example for this keyboard:
+```sh
+qmk flash -kb crkbd/r2g -km mb_via
+```
+
+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
+
+These PCBs have a reset on the underside of the PCB next to the TRRS jack to enter in to the bootloader.
+
+Additionally, if you hold down the "Q" or "P" buttons when plugging in that half of the keyboard (per the default QWERTY layout), this will jump to the bootloader and reset the EEPROM (persistent storage).