aboutsummaryrefslogtreecommitdiffstats
path: root/keyboards/lets_split/keymaps/henxing/Readme.md
diff options
context:
space:
mode:
authorHugh <henxing@gmail.com>2017-09-06 21:33:52 -0400
committerskullydazed <skullydazed@users.noreply.github.com>2017-09-06 18:33:52 -0700
commit0759adeaf1ecca3a30c639f36ab7c3f133c2351a (patch)
treeecfc55a2cc66cc90ec076fc9ab5bc844172a845c /keyboards/lets_split/keymaps/henxing/Readme.md
parent43a1ea30355bb31248ba54522f8eee1cd0db8754 (diff)
downloadfirmware-0759adeaf1ecca3a30c639f36ab7c3f133c2351a.tar.gz
firmware-0759adeaf1ecca3a30c639f36ab7c3f133c2351a.tar.bz2
firmware-0759adeaf1ecca3a30c639f36ab7c3f133c2351a.zip
Split atreus (#1680)
* Merge with upstream * Add split_atreus keymap for lets_split. * Move bspace * Tidy up keymap * Update layer enum * Temporary fix * Finish merge * Added keys for testing * Revert temporary fix * Remake keymap using default let's split map as base. ASCII art not updated * Remove non-functioning layers * Rename folder * Update ASCII art * Remove vestiges of ADJUST layer * Remove nonexistent layer #defines * Rename folder to avoid confusion * Add Readme.md * Formatting * Description of underscores in layer maps
Diffstat (limited to 'keyboards/lets_split/keymaps/henxing/Readme.md')
-rw-r--r--keyboards/lets_split/keymaps/henxing/Readme.md51
1 files changed, 51 insertions, 0 deletions
diff --git a/keyboards/lets_split/keymaps/henxing/Readme.md b/keyboards/lets_split/keymaps/henxing/Readme.md
new file mode 100644
index 000000000..231aa6adf
--- /dev/null
+++ b/keyboards/lets_split/keymaps/henxing/Readme.md
@@ -0,0 +1,51 @@
+# Let's Split the Atreus
+
+This keymap is a port of the Atreus keymap to the Let's Split keyboard, using a
+similar method of handling layer switches as the `default` keymap.
+
+
+# Layers
+
+The following tables are the layers as implemented.
+
+### Underscores in Layer
+
+Any underscore represents a key that is mapped to `KC_NO`, or no keypress. The
+2x3 block in the middle is like this because the Atreus does not have any keys
+there. It has been left blank for the user to add her own special keypresses or
+macros that she finds useful to have on that particular layer.
+
+
+## `_QWERTY`
+
+```c
+/*
+ * q w e r t _ _ y u i o p
+ * a s d f g _ _ h j k l ;
+ * z x c v b _ _ n m , . /
+ * esc tab gui shift bksp ctrl alt space fn - ' enter
+ */
+ ```
+
+
+## `_LOWER`
+
+```c
+/*
+ * ! @ up { } _ _ pgup 7 8 9 *
+ * # left down right $ _ _ pgdn 4 5 6 +
+ * [ ] ( ) & _ _ ` 1 2 3 \
+ * lower insert gui shift bksp ctrl alt space fn . 0 =
+ */
+ ```
+
+## `_RAISE`
+
+```c
+/*
+ * insert home up end pgup _ _ up F7 F8 F9 F10
+ * del left down right pgdn _ _ down F4 F5 F6 F11
+ * _ volup _ _ reset _ _ F1 F2 F3 F12
+ * _ voldn super shift bksp ctrl alt space L0 prtsc scroll pause
+ */
+ ```