Browse Source

[Keyboard] doro67 readme clarification (#5736)

* readme clarification

* Apply suggestions from code review

verbiage updates

Co-Authored-By: dperegolise <danielperegolise@gmail.com>

* mechmerlin suggested verbiage
Daniel Peregolise 6 years ago
parent
commit
7c2a7ab817

+ 7 - 0
keyboards/doro67/multi/keymaps/default/readme.md

@@ -1,5 +1,12 @@
 # Default Doro67 ANSI layout.
 
+**THIS IS THE DEFAULT ANSI KEYMAP (AVAILABILITY: CHINA + INTERNATIONAL GB)**
+The "multi" directory includes keymaps for the multi-layout PCB, which supports ANSI, ISO, and multi (split backspace & non-blocker).
+The keymap you choose from the "multi" directory must correspond to the integrated plate option you chose.
+
+The multi-layout PCB and RGB pcb were the only two options available to NON-china buyers.
+If you purchased an RGB PCB, please see the 'rgb' directory.
+
 This is the default ANSI layout that comes flashed on the Doro67 multi PCB with
 the exception of adding backtick as it was not mapped.
 

+ 7 - 0
keyboards/doro67/multi/keymaps/default_iso/readme.md

@@ -1,5 +1,12 @@
 # Default Doro67 ISO layout.
 
+**THIS IS THE DEFAULT ISO KEYMAP (AVAILABILITY: CHINA + INTERNATIONAL GB)**
+The "multi" directory includes keymaps for the multi-layout PCB, which supports ANSI, ISO, and multi (split backspace & non-blocker).
+The keymap you choose from the "multi" directory must correspond to the integrated plate option you chose.
+
+The multi-layout PCB and RGB pcb were the only two options available to NON-china buyers.
+If you purchased an RGB PCB, please see the 'rgb' directory.
+
 This is the default ISO layout that comes flashed on the Doro67 multi PCB with
 the exception of adding backtick and UK ISO specific keycodes as they were not mapped.
 

+ 7 - 0
keyboards/doro67/multi/keymaps/default_multi/readme.md

@@ -1,5 +1,12 @@
 # Default Doro67 Multi layout.
 
+**THIS IS THE DEFAULT MULTI-LAYOUT (SPLIT BACKSPACE) KEYMAP (AVAILABILITY: CHINA + INTERNATIONAL GB)**
+The "multi" directory includes keymaps for the multi-layout PCB, which supports ANSI, ISO, and multi (split backspace & non-blocker).
+The keymap you choose from the "multi" directory must correspond to the integrated plate option you chose.
+
+The multi-layout PCB and RGB pcb were the only two options available to NON-china buyers.
+If you purchased an RGB PCB, please see the 'rgb' directory.
+
 This is the default Multi layout that comes flashed on the Doro67 multi PCB with
 the exception of adding backtick as it was not mapped.
 

+ 7 - 0
keyboards/doro67/multi/readme.md

@@ -2,6 +2,13 @@
 
 65% custom keyboard made by 80ultraman/Alf/Backprop Studios with multiple layout support. Despite the layout options available, layout is dictated by the selected integrated plate.  
 
+**MULTI-LAYOUT PCB (AVAILABILITY: CHINA + INTERNATIONAL GB)**
+The "multi" directory includes keymaps for the multi-layout PCB, which supports ANSI, ISO, and multi (split backspace & non-blocker).
+The keymap you choose from the "multi" directory must correspond to the integrated plate option you chose.
+
+The multi-layout PCB and RGB pcb were the only two options available to NON-china buyers.
+If you purchased an RGB PCB, please see the 'rgb' directory.
+
 Keyboard Maintainer: [ShadeDream](https://github.com/shadedream)  
 Hardware Supported: Doro67 Multi PCB  
 Hardware Availability: [Geekhack GB](https://geekhack.org/index.php?topic=97265.0)

+ 4 - 0
keyboards/doro67/regular/keymaps/default/readme.md

@@ -1 +1,5 @@
 # The default keymap for doro67
+
+**THIS IS THE DEFAULT KEYMAP DIRECTORY (AVAILABILITY: CHINA GB ONLY)**
+If you are a non-china buyer, you probably have the multi PCB or rgb PCB. 
+Please look at the "multi" and "rgb" readme files.

+ 4 - 0
keyboards/doro67/regular/readme.md

@@ -4,6 +4,10 @@
 
 This is not the PCB with RGB support. Do not flash RGB firmware for this board. 
 
+**REGULAR PCB (AVAILABILITY: CHINA GB ONLY)*
+If you are a non-china buyer, you probably have the multi PCB or rgb PCB. 
+Please look at the "multi" and "rgb" readme files.
+
 Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin)  
 Hardware Supported: Doro67 Regular PCB  
 Hardware Availability: [Geekhack GB](https://geekhack.org/index.php?topic=97265.0)

+ 6 - 0
keyboards/doro67/rgb/keymaps/default/readme.md

@@ -1 +1,7 @@
 # The default keymap for rgb
+
+**RGB PCB (AVAILABILITY: CHINA + INTERNATIONAL GB)**
+The "rgb" directory includes the keymap for the RGB PCB.
+
+The multi-layout PCB and RGB pcb were the only two options available to NON-china buyers.
+If you purchased a non-rgb PCB, please see the 'multi' directory.

+ 6 - 0
keyboards/doro67/rgb/readme.md

@@ -4,6 +4,12 @@
 
 Flashing the regular PCB firmware on this board will work, but will disable RGB lighting. 
 
+**THIS IS THE RGB PCB DIRECTORY (AVAILABILITY: CHINA + INTERNATIONAL GB)**
+The "rgb" directory includes the keymap for the RGB PCB.
+
+The multi-layout PCB and RGB pcb were the only two options available to NON-china buyers.
+If you purchased a non-rgb PCB, please see the 'multi' directory.
+
 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)