]> git.donarmstrong.com Git - qmk_firmware.git/commitdiff
updated readme and tweaked keymap
authorBenjamin Kesselring <benji@Benjamins-MacBook-Pro.local>
Sat, 29 Jul 2017 22:56:54 +0000 (16:56 -0600)
committerJack Humbert <jack.humb@gmail.com>
Sun, 30 Jul 2017 04:46:08 +0000 (00:46 -0400)
keyboards/xd75/keymaps/default/keymap.c
keyboards/xd75/readme.md

index 543e1fa4006c3bae63742d66c063f165c363edf3..82ea1f2be85099a2485526e1aa43ea4f9111d773 100644 (file)
 #define _RS 4
 #define _FN 5
 
-/* ROW 1 OPTIONS
- * .--------------------------------------------------------------------------------------------------------------------------------------.
- * |        |        |        |        |        |        |        |        |        |        |        |        |        |        |        |
- * '--------------------------------------------------------------------------------------------------------------------------------------'
- *                                                                                                                      .- 2u ------------.
- *                                                                                                                      | KEY    . XXXXXX |
- *                                                                                                                      '-----------------'
- */
-/* ROW 2 OPTIONS
- * .--------------------------------------------------------------------------------------------------------------------------------------.
- * |        |        |        |        |        |        |        |        |        |        |        |        |        |        |        |
- * '--------------------------------------------------------------------------------------------------------------------------------------'
- * .- 2u ------------.                                                                                                  .- 2u ------------.
- * | KEY    . XXXXXX |                                                                                                  | KEY    . XXXXXX |
- * '-----------------'                                                                                                  '-----------------'
- */
-/* ROW 3 OPTIONS
- * .--------------------------------------------------------------------------------------------------------------------------------------.
- * |        |        |        |        |        |        |        |        |        |        |        |        |        |        |        |
- * '--------------------------------------------------------------------------------------------------------------------------------------'
- * .- 2u ------------.                                                                                         .- 2u ------------.
- * | KEY    . XXXXXX |                                                                                         |   X             |
- * '-----------------'                                                                                         '-----------------'
- *                                                                                                                      .- 2u ------------.
- *                                                                                                                      |   X             |
- *                                                                                                                      '-----------------'
- */
-/* ROW 4 OPTIONS
- * .--------------------------------------------------------------------------------------------------------------------------------------.
- * |        |        |        |        |        |        |        |        |        |        |        |        |        |        |        |
- * '--------------------------------------------------------------------------------------------------------------------------------------'
- *                                                                                                    .- 2u ------------.
- *                                                                                                    | KEY    . XXXXXX |
- *                                                                                                    '-----------------'
- * .- 2u ------------.                                                                                         .- 2u ------------.
- * | KEY    . XXXXXX |                                                                                         | KEY    . XXXXXX |
- * '-----------------'                                                                                         '-----------------'
- *                                                                                                                      .- 2u ------------.
- *                                                                                                                      | KEY    . XXXXXX |
- *                                                                                                                      '-----------------'
- */
-
-/* ROW 5 OPTIONS
- * .--------------------------------------------------------------------------------------------------------------------------------------.
- * |        |        |        |        |        |        |        |        |        |        |        |        |        |        |        |
- * '--------------------------------------------------------------------------------------------------------------------------------------'
- * .- 1.25u --+ 1.25u ------- 1.25u +--- 1.25u --- 2u -------------- 1.25u ---- 1.25u ------ 1.25u +---- 1.25u .
- * |   X      | X        |        X |      X    |   X             |   X      | X        |        X |      X    |
- * '-----------------------------------------------------------------------------------------------------------'
- *                                                                .- 2u ------------.
- *                                                                |   X             |
- *                                                                '-----------------'
- *                                  .--------------------- 6.25u ----------------------------.
- *                                  |                        X                               |
- *                                  '--------------------------------------------------------'
- *                       .----------------------- 6.25u ---------------------------- 1.25u ---- 1.25u ---- 1.25u ------ 1.25u +-- 1.25u --.
- *                       |                          X                             |     X    |   X      | X        |        X |      X    |
- *                       '----------------------------------------------------------------------------------------------------------------'
- */
-
 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 
 /* QWERTY - MIT ENHANCED / GRID COMPATIBLE
@@ -211,9 +148,9 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+- 2u ------------+--------|
  * | CAP LK | MS BT5 | MS BT4 | MS BT3 | MS BT2 | SLOW M | FAST M | NEXT   | VOL+   | VOL-   | PLAY   |        | XXXXXX .        | WHEEL+ |
  * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+- 2u ---------------------+--------|
- * | RGB TG | RGB MD | QWERTY | COLEMK | DVORAK |        |        |        |        |        |        | XXXXXX .        | MOUS U | WHEEL- |
- * |--------+--------+--------+--------+--------+- 2u ------------+--------+--------+--------+--------+-----------------+--------+--------|
- * | RESET  |        |        |        |        | XXXXXX . MS BT1 |        |        |        |        |        | MOUS L | MOUS D | MOUS R |
+ * | RGB TG | RGB MD | RGB HI | RGB HD | RGB SI | RGB SD | RGB VI | RGB VD | BL TOG | BL INC | BL DEC | XXXXXX .        | MOUS U | WHEEL- |
+ * |--------+--------+--------+--------+--------+-- 2u -----------+--------+--------+--------+--------+-----------------+--------+--------|
+ * | RESET  |        | QWERTY | COLEMK | DVORAK | XXXXXX . MS BT1 |        |        |        |        |        | MOUS L | MOUS D | MOUS R |
  * '--------------------------------------------------------------------------------------------------------------------------------------'
  */
  
@@ -221,8 +158,8 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
   { KC_NLCK, KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  ___T___, ___T___  },
   { KC_SLCK, KC_F13,  KC_F14,  KC_F15,  KC_F16,  KC_F17,  KC_F18,  KC_F19,  KC_F20,  KC_F21,  KC_F22,  KC_F23,  KC_F24,  KC_PAUS, KC_PSCR  },
   { KC_CAPS, KC_BTN5, KC_BTN4, KC_BTN3, KC_BTN2, KC_ACL0, KC_ACL2, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY, _______, ___T___, ___T___, KC_WH_U  },
-  { RGB_TOG, RGB_MOD, DF(_QW), DF(_CM), DF(_DV), _______, _______, _______, _______, _______, _______, ___T___, ___T___, KC_MS_U, KC_WH_D  },
-  { RESET  , RGB_HUI, RGB_HUD, RGB_SAI, RGB_SAD, RGB_VAI, RGB_VAD, _______, _______, _______, _______, _______, KC_MS_L, KC_MS_D, KC_MS_R  },
+  { RGB_TOG, RGB_MOD, RGB_HUI, RGB_HUD, RGB_SAI, RGB_SAD, RGB_VAI, RGB_VAD, BL_TOGG, BL_INC,  BL_DEC,   ___T___, ___T___, KC_MS_U, KC_WH_D  },
+  { RESET  , _______, DF(_QW), DF(_CM), DF(_DV), KC_BTN1, KC_BTN1, _______, _______, _______, _______, _______, KC_MS_L, KC_MS_D, KC_MS_R  },
  },
 };
 
index 126320872908f2a0f0bd2b2d908771e481ec0afa..0bc82be91e07f12c20d5cc02b8ba1a2db2e1a21f 100644 (file)
@@ -1,9 +1,11 @@
 xd75 keyboard firmware
 ======================
 
+The XD75Re is a 15x5 full-grid ortholinear keyboard manufactured by XIUDI. This port of the QMK firmware is my first shot at using QMK, so if you see any features done wrong (or just plain missing), feel free to fix them and put in a pull request!
+
 ## Quantum MK Firmware
 
-For the full Quantum feature list, see [the parent readme](/).
+For more info on this firmware (and how to make it your own), head over to [qmk.fm](http://qmk.fm).
 
 ## Building
 
@@ -17,7 +19,7 @@ To build with the default keymap, simply run `make default`.
 
 ### Other Keymaps
 
-Several version of keymap are available in advance but you are recommended to define your favorite layout yourself. To define your own keymap create a folder with the name of your keymap in the keymaps folder, and see keymap documentation (you can find in top readme.md) and existant keymap files.
+The "default" keymap included is basically the OLKB Atomic keymap with a few buttons added for RGB underglow control. This should be usable as a starting point, but most people will be best served creating their own keymap and flashing it - more info on creating your own keymap is available in [the official QMK documentation](https://docs.qmk.fm).
 
 To build the firmware binary hex file with a keymap just do `make` with a keymap like this: