summaryrefslogtreecommitdiffstats
path: root/keyboards/doro67/rgb/readme.md
diff options
context:
space:
mode:
authorMechMerlin <30334081+mechmerlin@users.noreply.github.com>2019-04-22 04:59:39 +0200
committerDrashna Jaelre <drashna@live.com>2019-04-22 04:59:39 +0200
commit81d8e6ef3e4d69dba8e9ba40db525ab4181ab3e3 (patch)
treec4ae5db53750a4a2bafe3efcf13686f1cba3973f /keyboards/doro67/rgb/readme.md
parent98f7af6d3b0e8f1b9d2926de1a10f60661769cc0 (diff)
downloadqmk_firmware-81d8e6ef3e4d69dba8e9ba40db525ab4181ab3e3.tar.gz
qmk_firmware-81d8e6ef3e4d69dba8e9ba40db525ab4181ab3e3.tar.xz
[Keyboard] Doro67 RGB PCB (#5677)
* initial commit * get rid of some of the vanilla code * set up matrix and pins * Create LAYOUT macro and an appropriate keymap * support for caps lock LED * add some documentation to the doro67 parent readme * align the language used in the several readme files * initial commit * get rid of some of the vanilla code * set up matrix and pins * Create LAYOUT macro and an appropriate keymap * support for caps lock LED * add some documentation to the doro67 parent readme * align the language used in the several readme files * Use RGB Matrix and fix enter key bug * fix formatting * remove merge conflict artifacts * make a more useful default keymap * add configurator support for the RGB pcb * fix rgb matrix based on new info. Multipler should be reversed * forgot to actually set the pin output for caps lock led * fix offset keys in layer 1 keymap * code cleanup * use macros for the rgb_led calculations struct * set RGB led num to 67 as I mistakenly counted the caps lock led * cleanup config.h file * add RGB note in readme * get consistent naming in config file * fix some inconsistencies * readjust matrix and get rid of macros based on drashna's suggestions
Diffstat (limited to 'keyboards/doro67/rgb/readme.md')
-rw-r--r--keyboards/doro67/rgb/readme.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/keyboards/doro67/rgb/readme.md b/keyboards/doro67/rgb/readme.md
new file mode 100644
index 000000000..3a527c933
--- /dev/null
+++ b/keyboards/doro67/rgb/readme.md
@@ -0,0 +1,17 @@
+# Doro67 RGB PCB
+
+65% custom keyboard made by 80ultraman/Alf/Backprop Studios with in switch RGB featuring the same switch matrix and layout as the regular PCB.
+
+Flashing the regular PCB firmware on this board will work, but will disable RGB lighting.
+
+Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin)
+Hardware Supported: Doro 67 RGB PCB
+Hardware Availability: [Geekhack GB](https://geekhack.org/index.php?topic=97265.0)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make doro67/rgb:default
+
+**RGB Note:** The WS2812 string of LEDs starts from the `K00` key connected to pin `B7` and is connected from left to right, top to bottom, following the physical layout of the board.
+
+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).