summaryrefslogtreecommitdiffstats
path: root/keyboards/org60/readme.md
diff options
context:
space:
mode:
authorThat-Canadian <poole.chris.11@gmail.com>2017-08-13 14:11:40 -0400
committerThat-Canadian <poole.chris.11@gmail.com>2017-08-13 14:11:40 -0400
commit1631f7cd798dcf428404977e441d7e5b65fe81ce (patch)
tree1c2c1d85598d7b1332e2e82b6276a49b2dc2d2b0 /keyboards/org60/readme.md
parentf64d4242ada746a1d7bd7aef9acf8f3cf8a5ba6f (diff)
parent09e5885e45cf37c0651744770cd99b5b744ba894 (diff)
Merge branch 'master' into minidox
Diffstat (limited to 'keyboards/org60/readme.md')
-rw-r--r--keyboards/org60/readme.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/keyboards/org60/readme.md b/keyboards/org60/readme.md
new file mode 100644
index 0000000000..8e02a40211
--- /dev/null
+++ b/keyboards/org60/readme.md
@@ -0,0 +1,21 @@
+# QMK Firmware for 大橘子外设 (Large Orange Peripheral)'s 60% Org60 PCB
+
+![Top View of a pair of XD60 Keyboards (same layout as Org60)](https://i.imgur.com/3Jq2743.jpg)
+
+
+## Quantum MK Firmware
+For the full Quantum feature list, see [the parent readme.md](/readme.md).
+
+
+## Additional Notes
+The Org60 seems to be a variant of the XD60 (which is essentially a GH60 rev. C, with support for a right-hand arrow cluster), which has USB-C and built-in RGB underlighting.
+
+Compatibility with GH60 expansion boards is unknown.
+
+Board also supports in-switch LEDs (two-pin, single colour), as well as WS2182 LED strips for underglow lighting.
+
+Default keymap included, matching configuration on sale page.
+
+
+## Build
+To build the default keymap, simply run `make org60-default`. \ No newline at end of file