summaryrefslogtreecommitdiff
path: root/keyboards/orthodox
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/orthodox')
-rw-r--r--keyboards/orthodox/keymaps/drashna/README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/keyboards/orthodox/keymaps/drashna/README.md b/keyboards/orthodox/keymaps/drashna/README.md
new file mode 100644
index 0000000000..c611617747
--- /dev/null
+++ b/keyboards/orthodox/keymaps/drashna/README.md
@@ -0,0 +1,26 @@
+Overview
+========
+
+This is my personal Orthodox configuration, and my daily driver.
+
+Most of the code resides in my userspace, rather than here, as I have multiple keyboards.
+
+How to build
+------------
+make orthodox/rev1:drashna:teensy
+
+Layers
+------
+* QWERTY/DVORAK/COLEMAK/WORKMAN: basic layout, default set like the OLKB boards. Default is set and persists on power cycle.
+* RAISE: Contains function keys and unshifted symbols
+* LOWER: Contains function keys and shifted symbols
+* ADJUST: contains special codes (layout defaults, RGB codes, Audio codes, and volume control)
+
+All layers have RGB specific indicators, so you can see what layer you're on by the underglow.
+
+Orthodox Specific Code
+----------------------
+
+Left side is designed to have RGB underglow and Faux Clicking enabled, while the right has Audio enabled.
+
+The make commend ensures that the correct settings are retained.