summaryrefslogtreecommitdiff
path: root/keyboards/xd60/keymaps/Jos/README.md
diff options
context:
space:
mode:
authorJean Olivier Simoneau <jean.olivier.simoneau@usherbrooke.ca>2017-12-14 00:21:48 -0500
committerJack Humbert <jack.humb@gmail.com>2017-12-14 00:21:48 -0500
commit1226c69f4f9fd4a573c314116439d884e5d4647c (patch)
treeb5992e20b1dcc1b26b2c544e38e3ce07a77dec27 /keyboards/xd60/keymaps/Jos/README.md
parent8a1e656099a966966e7c81b08d9fb2770e8a61ad (diff)
Adding my xd60 layout. (#2078)
* Added xd60:Jos keymap * Corrected Layout image for xd60:Jos layout * Update README for xd60:Jos layout * Created rules.mk for xd60:Jos layout * Fixed an edge case for xd60:Jos layout * Now using a specific for xd60:Jos layout instead of modifying the main one * Better physical layout image for xd60:Jos layout
Diffstat (limited to 'keyboards/xd60/keymaps/Jos/README.md')
-rw-r--r--keyboards/xd60/keymaps/Jos/README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/keyboards/xd60/keymaps/Jos/README.md b/keyboards/xd60/keymaps/Jos/README.md
new file mode 100644
index 0000000000..b4382acfeb
--- /dev/null
+++ b/keyboards/xd60/keymaps/Jos/README.md
@@ -0,0 +1,22 @@
+# Jos's Layout
+
+Custom layout with various options. Designed to be used with the Canadian Multilingual software layout.
+
+## Layout
+This is the physical layout of my xd60, for reference. See the keymap file for actual software layout.
+![Keyboard Layout (Physical appearence)](https://i.imgur.com/qzOmqyq.png "Physical Layout")
+
+## Features
+**Caps Lock** is **Escape** and the **Window key** is a **Function** key that still acts like the **Window** key in conjuction with `w`, `s`, `d`, `l`, `t`, `e`, `h`, and `SPACE`.
+
+There are a few `#define` lines at the beginning of the keymap file that enable the following options if not commented:
+- `ISOLIKE_ALT_ENTER`: `RALT` + `ENT` is the same as `RALT`+`BSLS`. For logical placement of `{` and `}` (the former being `RALT`+`BSLS`) with ANSI enter on a ISO-based layout.
+- `TWO_SFT_CAPS`: Both shifts together → Caps Lock.
+- `APP_IS_RALT_RCTRL`: Menu would be between `RCTRL` and `RALT`, so now `RALT` + `RCTRL` → `APP`.
+- `HELD_ESC_IS_SHIFT`: Holding `ESC` → `SHIFT`. It always register shift when pressing `ESC`. Useful for VIM.
+- `BSPC_BLOCKS_DEL`: If `BSPC` is held, we disable `DEL`. To avoid acidental presses of `DEL` with split backspace key.
+- `ALT_MINSEQL_IS_ALT_78`: Pressing `ALT+MINS/EQL` will act like `ALT+7/8`. Will yield `{}` instead of `½¬` in Canadian Multilingual Layout. Diminished finger stretching.
+
+
+# Build
+To build, simply run `make xd60:Jos`