summaryrefslogtreecommitdiffstats
path: root/keyboards/octagon/readme.md
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 /keyboards/octagon/readme.md
parentb3bcafcc4bf1314632af822db9ddb1783ebb97cf (diff)
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
Diffstat (limited to 'keyboards/octagon/readme.md')
-rw-r--r--keyboards/octagon/readme.md9
1 files changed, 9 insertions, 0 deletions
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