XMMX refactor, Configurator support and readme update (qmk#4722)

* XMMX: matrix and keymap refactor - xmmx.h updated to use #pragma once - renamed LAYOUT_ansi_wk macro to LAYOUT_tkl_ansi - renamed LAYOUT_ansi_wkl macro to LAYOUT_tkl_ansi_wkl - renamed LAYOUT_iso_wk macro to LAYOUT_tkl_iso - renamed LAYOUT_iso_wkl macro to LAYOUT_tkl_iso_wkl * XMMX: Configurator support * XMMX: readme update
yeliu84 · Jan 7, 2019 · bd08e39 · bd08e39
1 parent d966116
commit bd08e39
Show file tree

Hide file tree

Showing 8 changed files with 505 additions and 27 deletions.
diff --git a/keyboards/xmmx/info.json b/keyboards/xmmx/info.json
diff --git a/keyboards/xmmx/keymaps/ansi_wk/keymap.c b/keyboards/xmmx/keymaps/ansi_wk/keymap.c
@@ -2,12 +2,13 @@
 
 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 
-	LAYOUT_ansi_wk(
-	KC_ESC,   KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12,                            KC_PSCR, KC_SLCK, KC_PAUS, \
+  LAYOUT_tkl_ansi(
+    KC_ESC,           KC_F1, KC_F2, KC_F3, KC_F4,     KC_F5, KC_F6, KC_F7, KC_F8,     KC_F9, KC_F10, KC_F11, KC_F12,            KC_PSCR, KC_SLCK, KC_PAUS, \
     KC_GRV,   KC_1,   KC_2,   KC_3,   KC_4,   KC_5,   KC_6,   KC_7,   KC_8,   KC_9,   KC_0,KC_MINS, KC_EQL,  KC_BSPC,           KC_INS,KC_HOME, KC_PGUP,   \
     KC_TAB,   KC_Q,   KC_W,   KC_E,   KC_R,   KC_T,   KC_Y,   KC_U,   KC_I,   KC_O,   KC_P,KC_LBRC, KC_RBRC, KC_BSLS,           KC_DEL, KC_END, KC_PGDN,   \
     KC_CAPS,  KC_A,   KC_S,   KC_D,   KC_F,   KC_G,   KC_H,   KC_J,   KC_K,   KC_L,   KC_SCLN,KC_QUOT,          KC_ENT,                                    \
     KC_LSFT,          KC_Z,   KC_X,   KC_C,   KC_V,   KC_B,   KC_N,   KC_M,   KC_COMM,KC_DOT, KC_SLSH, KC_RSFT,                         KC_UP,             \
     KC_LCTL,KC_LGUI,KC_LALT,                                  KC_SPC,                 KC_RALT,KC_RGUI, KC_APP,KC_RCTL,          KC_LEFT,KC_DOWN,KC_RGHT
-	)
+  )
 };
+
diff --git a/keyboards/xmmx/keymaps/ansi_wkl/keymap.c b/keyboards/xmmx/keymaps/ansi_wkl/keymap.c
@@ -2,12 +2,13 @@
 
 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 
-	LAYOUT_ansi_wkl(
-	KC_ESC,   KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12,                            KC_PSCR, KC_SLCK, KC_PAUS, \
+  LAYOUT_tkl_ansi_wkl(
+    KC_ESC,           KC_F1, KC_F2, KC_F3, KC_F4,     KC_F5, KC_F6, KC_F7, KC_F8,     KC_F9, KC_F10, KC_F11, KC_F12,            KC_PSCR, KC_SLCK, KC_PAUS, \
     KC_GRV,   KC_1,   KC_2,   KC_3,   KC_4,   KC_5,   KC_6,   KC_7,   KC_8,   KC_9,   KC_0,KC_MINS, KC_EQL,  KC_BSPC,           KC_INS,KC_HOME, KC_PGUP,   \
     KC_TAB,   KC_Q,   KC_W,   KC_E,   KC_R,   KC_T,   KC_Y,   KC_U,   KC_I,   KC_O,   KC_P,KC_LBRC, KC_RBRC, KC_BSLS,           KC_DEL, KC_END, KC_PGDN,   \
     KC_CAPS,  KC_A,   KC_S,   KC_D,   KC_F,   KC_G,   KC_H,   KC_J,   KC_K,   KC_L,   KC_SCLN,KC_QUOT,          KC_ENT,                                    \
     KC_LSFT,          KC_Z,   KC_X,   KC_C,   KC_V,   KC_B,   KC_N,   KC_M,   KC_COMM,KC_DOT, KC_SLSH, KC_RSFT,                          KC_UP,            \
     KC_LCTL,        KC_LALT,                                  KC_SPC,                 KC_RALT,      KC_RCTL,                    KC_LEFT,KC_DOWN,KC_RGHT
-	)
+  )
 };
+
diff --git a/keyboards/xmmx/keymaps/default/keymap.c b/keyboards/xmmx/keymaps/default/keymap.c
@@ -2,12 +2,13 @@
 
 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 
-	LAYOUT_all(
-	KC_ESC,   KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12,                            KC_PSCR, KC_SLCK, KC_PAUS, \
+  LAYOUT_all(
+    KC_ESC,           KC_F1, KC_F2, KC_F3, KC_F4,     KC_F5, KC_F6, KC_F7, KC_F8,     KC_F9, KC_F10, KC_F11, KC_F12,            KC_PSCR, KC_SLCK, KC_PAUS, \
     KC_GRV,   KC_1,   KC_2,   KC_3,   KC_4,   KC_5,   KC_6,   KC_7,   KC_8,   KC_9,   KC_0,KC_MINS, KC_EQL,  KC_BSPC, KC_BSPC,  KC_INS,KC_HOME, KC_PGUP,   \
     KC_TAB,   KC_Q,   KC_W,   KC_E,   KC_R,   KC_T,   KC_Y,   KC_U,   KC_I,   KC_O,   KC_P,KC_LBRC, KC_RBRC, KC_BSLS,           KC_DEL, KC_END, KC_PGDN,   \
     KC_CAPS,  KC_A,   KC_S,   KC_D,   KC_F,   KC_G,   KC_H,   KC_J,   KC_K,   KC_L,   KC_SCLN,KC_QUOT, KC_NUHS, KC_ENT,         KC_NO,  KC_NO, KC_NO,      \
     KC_LSFT,KC_NUBS,  KC_Z,   KC_X,   KC_C,   KC_V,   KC_B,   KC_N,   KC_M,   KC_COMM,KC_DOT, KC_SLSH, KC_RSFT, KC_RSFT,        KC_NO,  KC_UP, KC_NO,      \
     KC_LCTL,KC_LGUI,KC_LALT,                                  KC_SPC,                 KC_RALT,KC_RGUI, KC_APP,KC_RCTL,          KC_LEFT,KC_DOWN,KC_RGHT
-	)
+  )
 };
+
diff --git a/keyboards/xmmx/keymaps/iso_wk/keymap.c b/keyboards/xmmx/keymaps/iso_wk/keymap.c
@@ -2,12 +2,13 @@
 
 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 
-	LAYOUT_iso_wk(
-	KC_ESC,   KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12,                            KC_PSCR, KC_SLCK, KC_PAUS, \
+  LAYOUT_tkl_iso(
+    KC_ESC,           KC_F1, KC_F2, KC_F3, KC_F4,     KC_F5, KC_F6, KC_F7, KC_F8,     KC_F9, KC_F10, KC_F11, KC_F12,            KC_PSCR, KC_SLCK, KC_PAUS, \
     KC_GRV,   KC_1,   KC_2,   KC_3,   KC_4,   KC_5,   KC_6,   KC_7,   KC_8,   KC_9,   KC_0,KC_MINS, KC_EQL,  KC_BSPC,           KC_INS,KC_HOME, KC_PGUP,   \
     KC_TAB,   KC_Q,   KC_W,   KC_E,   KC_R,   KC_T,   KC_Y,   KC_U,   KC_I,   KC_O,   KC_P,KC_LBRC, KC_RBRC,                    KC_DEL, KC_END, KC_PGDN,   \
     KC_CAPS,  KC_A,   KC_S,   KC_D,   KC_F,   KC_G,   KC_H,   KC_J,   KC_K,   KC_L,   KC_SCLN,KC_QUOT, KC_NUHS, KC_ENT,                                    \
     KC_LSFT,  KC_NUBS,KC_Z,   KC_X,   KC_C,   KC_V,   KC_B,   KC_N,   KC_M,   KC_COMM,KC_DOT, KC_SLSH, KC_RSFT,                         KC_UP,             \
     KC_LCTL,KC_LGUI,KC_LALT,                                  KC_SPC,                 KC_RALT,KC_RGUI, KC_APP,KC_RCTL,          KC_LEFT,KC_DOWN,KC_RGHT
-	)
+  )
 };
+
diff --git a/keyboards/xmmx/keymaps/iso_wkl/keymap.c b/keyboards/xmmx/keymaps/iso_wkl/keymap.c
@@ -2,12 +2,13 @@
 
 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 
-	LAYOUT_iso_wkl(
-	KC_ESC,   KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12,                            KC_PSCR, KC_SLCK, KC_PAUS, \
+  LAYOUT_tkl_iso_wkl(
+    KC_ESC,           KC_F1, KC_F2, KC_F3, KC_F4,     KC_F5, KC_F6, KC_F7, KC_F8,     KC_F9, KC_F10, KC_F11, KC_F12,            KC_PSCR, KC_SLCK, KC_PAUS, \
     KC_GRV,   KC_1,   KC_2,   KC_3,   KC_4,   KC_5,   KC_6,   KC_7,   KC_8,   KC_9,   KC_0,KC_MINS, KC_EQL,  KC_BSPC,           KC_INS,KC_HOME, KC_PGUP,   \
     KC_TAB,   KC_Q,   KC_W,   KC_E,   KC_R,   KC_T,   KC_Y,   KC_U,   KC_I,   KC_O,   KC_P,KC_LBRC, KC_RBRC,                    KC_DEL, KC_END, KC_PGDN,   \
     KC_CAPS,  KC_A,   KC_S,   KC_D,   KC_F,   KC_G,   KC_H,   KC_J,   KC_K,   KC_L,   KC_SCLN,KC_QUOT, KC_NUHS, KC_ENT,                                    \
     KC_LSFT,  KC_NUBS,KC_Z,   KC_X,   KC_C,   KC_V,   KC_B,   KC_N,   KC_M,   KC_COMM,KC_DOT, KC_SLSH, KC_RSFT,                         KC_UP,             \
     KC_LCTL,        KC_LALT,                                  KC_SPC,                 KC_RALT,                KC_RCTL,          KC_LEFT,KC_DOWN,KC_RGHT
-	)
+  )
 };
+
diff --git a/keyboards/xmmx/readme.md b/keyboards/xmmx/readme.md
@@ -1,14 +1,14 @@
 # XMMX
 
-XMMX: Tenkeyless Mechanical Keyboard PCB designed to fit Filco Majestouch TKL and Cooler Master Quickfire Rapid cases
+XMMX is a Tenkeyless Mechanical Keyboard PCB designed to fit Filco Majestouch TKL and Cooler Master Quickfire Rapid cases. 
 
-XMMX schematic and PCB are available opensource under Creative Commons BY-SA 3.0 license on EasyEDA at [this link](https://easyeda.com/farmakon/XMMX-0447d28c1e4644b88fd04905d983684d)
+XMMX schematic and PCB are available opensource under Creative Commons BY-SA 3.0 license on EasyEDA at [this link](https://easyeda.com/farmakon/XMMX-0447d28c1e4644b88fd04905d983684d).
 
-For more informations on the XMMX please visit this [geekhack.org thread](https://geekhack.org/index.php?topic=93422.0)
+For more informations on the XMMX please visit [this geekhack.org thread](https://geekhack.org/index.php?topic=93422.0).
 
-Make examples for these keyboards (after setting up your build environment):
+Make example for this keyboard (after setting up your build environment):
 
     make xmmx:default
 
+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).
 
-See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) then the [make instructions](https://docs.qmk.fm/make_instructions.html) for more information.
diff --git a/keyboards/xmmx/xmmx.h b/keyboards/xmmx/xmmx.h
@@ -1,5 +1,4 @@
-#ifndef XMMX
-#define XMMX
+#pragma once
 
 #include "quantum.h"
 
@@ -21,7 +20,7 @@
 }
 
 // 80% keyboard: ANSI Winkey
-#define LAYOUT_ansi_wk( \
+#define LAYOUT_tkl_ansi( \
 	K000,       K001, K002, K003, K004, K005, K006, K007, K008, K009, K010, K011, K012, K014, K015, K016, \
 	K100, K101, K102, K103, K104, K105, K106, K107, K108, K109, K110, K111, K112, K113, K114, K115, K116, \
 	K200, K201, K202, K203, K204, K205, K206, K207, K208, K209, K210, K211, K212, K213, K214, K215, K216, \
@@ -38,7 +37,7 @@
 }
 
 // 80% keyboard: ANSI Winkeyless
-#define LAYOUT_ansi_wkl( \
+#define LAYOUT_tkl_ansi_wkl( \
 	K000,       K001, K002, K003, K004, K005, K006, K007, K008, K009, K010, K011, K012, K014, K015, K016, \
 	K100, K101, K102, K103, K104, K105, K106, K107, K108, K109, K110, K111, K112, K113, K114, K115, K116, \
 	K200, K201, K202, K203, K204, K205, K206, K207, K208, K209, K210, K211, K212, K213, K214, K215, K216, \
@@ -55,7 +54,7 @@
 }
 
 // 80% keyboard: ISO Winkey
-#define LAYOUT_iso_wk( \
+#define LAYOUT_tkl_iso( \
 	K000,       K001, K002, K003, K004, K005, K006, K007, K008, K009, K010, K011, K012, K014, K015, K016, \
 	K100, K101, K102, K103, K104, K105, K106, K107, K108, K109, K110, K111, K112, K113, K114, K115, K116, \
 	K200, K201, K202, K203, K204, K205, K206, K207, K208, K209, K210, K211, K212,       K214, K215, K216, \
@@ -72,7 +71,7 @@
 }
 
 // 80% keyboard: ISO Winkeyless
-#define LAYOUT_iso_wkl( \
+#define LAYOUT_tkl_iso_wkl( \
 	K000,       K001, K002, K003, K004, K005, K006, K007, K008, K009, K010, K011, K012, K014, K015, K016, \
 	K100, K101, K102, K103, K104, K105, K106, K107, K108, K109, K110, K111, K112, K113, K114, K115, K116, \
 	K200, K201, K202, K203, K204, K205, K206, K207, K208, K209, K210, K211, K212,       K214, K215, K216, \
@@ -88,4 +87,3 @@
 	{ K500, KC_NO,K502, KC_NO,KC_NO,KC_NO,KC_NO,K507, KC_NO,KC_NO,KC_NO,K511, KC_NO,K513, K514, K515, K516 }  \
 }
 
-#endif