summaryrefslogtreecommitdiff
path: root/keyboards/org60/readme.md
diff options
context:
space:
mode:
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