summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMechMerlin <30334081+mechmerlin@users.noreply.github.com>2017-12-19 07:50:58 -0800
committerJack Humbert <jack.humb@gmail.com>2017-12-19 10:50:58 -0500
commit9dd3e08fdd7e84f77692d5d611fb4ac67d6d82ba (patch)
tree5fe506ead8b4fec5f12cb240a68e88b6519390dd
parentb3bcafcc4bf1314632af822db9ddb1783ebb97cf (diff)
downloadqmk_firmware-9dd3e08fdd7e84f77692d5d611fb4ac67d6d82ba.tar.gz
qmk_firmware-9dd3e08fdd7e84f77692d5d611fb4ac67d6d82ba.zip
Octagon V2 Refactor (#2170)
* rename octagon_v2 directory to octagon directory * Move octagon_v2 files to v2 sub-directory * Edit readme files * setup header files for building multiple versions of the Duck Octagon. * Changes as per Jack's PR 2170 comments
-rw-r--r--keyboards/octagon/keymaps/default/keymap.c (renamed from keyboards/octagon_v2/keymaps/default/keymap.c)2
-rw-r--r--keyboards/octagon/keymaps/default/readme.md (renamed from keyboards/octagon_v2/keymaps/default/readme.md)0
-rw-r--r--keyboards/octagon/octagon.c1
-rw-r--r--keyboards/octagon/octagon.h10
-rw-r--r--keyboards/octagon/readme.md9
-rw-r--r--keyboards/octagon/rules.mk1
-rw-r--r--keyboards/octagon/v2/config.h (renamed from keyboards/octagon_v2/config.h)0
-rw-r--r--keyboards/octagon/v2/indicator_leds.c (renamed from keyboards/octagon_v2/indicator_leds.c)0
-rw-r--r--keyboards/octagon/v2/indicator_leds.h (renamed from keyboards/octagon_v2/indicator_leds.h)0
-rw-r--r--keyboards/octagon/v2/matrix.c (renamed from keyboards/octagon_v2/matrix.c)0
-rw-r--r--keyboards/octagon/v2/readme.md (renamed from keyboards/octagon_v2/readme.md)4
-rw-r--r--keyboards/octagon/v2/rules.mk (renamed from keyboards/octagon_v2/rules.mk)0
-rw-r--r--keyboards/octagon/v2/v2.c (renamed from keyboards/octagon_v2/octagon_v2.c)2
-rw-r--r--keyboards/octagon/v2/v2.h (renamed from keyboards/octagon_v2/octagon_v2.h)6
14 files changed, 28 insertions, 7 deletions
diff --git a/keyboards/octagon_v2/keymaps/default/keymap.c b/keyboards/octagon/keymaps/default/keymap.c
index 123da6069c..5fd2d0aeb9 100644
--- a/keyboards/octagon_v2/keymaps/default/keymap.c
+++ b/keyboards/octagon/keymaps/default/keymap.c
@@ -13,7 +13,7 @@
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-#include "octagon_v2.h"
+#include "octagon.h"
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
/* layer 0: qwerty */
diff --git a/keyboards/octagon_v2/keymaps/default/readme.md b/keyboards/octagon/keymaps/default/readme.md
index 456fc3ecb8..456fc3ecb8 100644
--- a/keyboards/octagon_v2/keymaps/default/readme.md
+++ b/keyboards/octagon/keymaps/default/readme.md
diff --git a/keyboards/octagon/octagon.c b/keyboards/octagon/octagon.c
new file mode 100644
index 0000000000..6eb9e73b24
--- /dev/null
+++ b/keyboards/octagon/octagon.c
@@ -0,0 +1 @@
+#include "octagon.h"
diff --git a/keyboards/octagon/octagon.h b/keyboards/octagon/octagon.h
new file mode 100644
index 0000000000..d48a715bbc
--- /dev/null
+++ b/keyboards/octagon/octagon.h
@@ -0,0 +1,10 @@
+#ifndef OCTAGON_H
+#define OCTAGON_H
+
+#include "quantum.h"
+
+#ifdef KEYBOARD_octagon_v2
+ #include "v2.h"
+#endif
+
+#endif
diff --git a/keyboards/octagon/readme.md b/keyboards/octagon/readme.md
new file mode 100644
index 0000000000..bf937a3f66
--- /dev/null
+++ b/keyboards/octagon/readme.md
@@ -0,0 +1,9 @@
+# Duck Octagon
+
+Non official firmware for custom Korean keyboard with 75% key layout made by Duck.
+
+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.
+
+Make example for this keyboard (after setting up your build environment):
+
+ make octagon/v2:default
diff --git a/keyboards/octagon/rules.mk b/keyboards/octagon/rules.mk
new file mode 100644
index 0000000000..ce04362e6f
--- /dev/null
+++ b/keyboards/octagon/rules.mk
@@ -0,0 +1 @@
+DEFAULT_FOLDER = octagon/v2 \ No newline at end of file
diff --git a/keyboards/octagon_v2/config.h b/keyboards/octagon/v2/config.h
index c916a30a1e..c916a30a1e 100644
--- a/keyboards/octagon_v2/config.h
+++ b/keyboards/octagon/v2/config.h
diff --git a/keyboards/octagon_v2/indicator_leds.c b/keyboards/octagon/v2/indicator_leds.c
index c24509f514..c24509f514 100644
--- a/keyboards/octagon_v2/indicator_leds.c
+++ b/keyboards/octagon/v2/indicator_leds.c
diff --git a/keyboards/octagon_v2/indicator_leds.h b/keyboards/octagon/v2/indicator_leds.h
index 9bb2c8ced9..9bb2c8ced9 100644
--- a/keyboards/octagon_v2/indicator_leds.h
+++ b/keyboards/octagon/v2/indicator_leds.h
diff --git a/keyboards/octagon_v2/matrix.c b/keyboards/octagon/v2/matrix.c
index e113e50772..e113e50772 100644
--- a/keyboards/octagon_v2/matrix.c
+++ b/keyboards/octagon/v2/matrix.c
diff --git a/keyboards/octagon_v2/readme.md b/keyboards/octagon/v2/readme.md
index 37783c84ce..125f09f9cd 100644
--- a/keyboards/octagon_v2/readme.md
+++ b/keyboards/octagon/v2/readme.md
@@ -9,7 +9,7 @@ Hardware Availability: Wait until GB of the next revision
Make example for this keyboard (after setting up your build environment):
- make octagon_v2:default
+ make octagon/v2:default
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.
@@ -25,4 +25,4 @@ The Duck Octagon V2 PCB consists of:
## Notes
Thanks to Ralf Schmitt for previous implementations in his [TMK fork](https://github.com/xauser/tmk_keyboard/tree/xauser/) and few helping words.
-Based heavily on Rasmus Schults [Duck Lightsaver QMK Port](https://github.com/qmk/qmk_firmware/tree/master/keyboards/lightsaver) \ No newline at end of file
+Based heavily on Rasmus Schults [Duck Lightsaver QMK Port](https://github.com/qmk/qmk_firmware/tree/master/keyboards/lightsaver)
diff --git a/keyboards/octagon_v2/rules.mk b/keyboards/octagon/v2/rules.mk
index d95dbd9603..d95dbd9603 100644
--- a/keyboards/octagon_v2/rules.mk
+++ b/keyboards/octagon/v2/rules.mk
diff --git a/keyboards/octagon_v2/octagon_v2.c b/keyboards/octagon/v2/v2.c
index 05c12c527b..52653b37e7 100644
--- a/keyboards/octagon_v2/octagon_v2.c
+++ b/keyboards/octagon/v2/v2.c
@@ -13,7 +13,7 @@
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-#include "octagon_v2.h"
+#include "v2.h"
#include "indicator_leds.h"
enum BACKLIGHT_AREAS {
diff --git a/keyboards/octagon_v2/octagon_v2.h b/keyboards/octagon/v2/v2.h
index 64d2d0169b..7ad9f3826b 100644
--- a/keyboards/octagon_v2/octagon_v2.h
+++ b/keyboards/octagon/v2/v2.h
@@ -13,10 +13,10 @@
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-#ifndef OCTAGON_V2_H
-#define OCTAGON_V2_H
+#ifndef V2_H
+#define V2_H
-#include "quantum.h"
+#include "../octagon.h"
#define KEYMAP( \
K5A, K5B, K5C, K5D, K5E, K5F, K5G, K5H, K5I, K5J, K5K, K5L, K5M, K5N, K5O, K5Q, \