summaryrefslogtreecommitdiffstats
path: root/keyboards/ergodox/keymaps/deadcyclo/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/ergodox/keymaps/deadcyclo/readme.md')
-rw-r--r--keyboards/ergodox/keymaps/deadcyclo/readme.md36
1 files changed, 36 insertions, 0 deletions
diff --git a/keyboards/ergodox/keymaps/deadcyclo/readme.md b/keyboards/ergodox/keymaps/deadcyclo/readme.md
new file mode 100644
index 0000000000..809dd6eb56
--- /dev/null
+++ b/keyboards/ergodox/keymaps/deadcyclo/readme.md
@@ -0,0 +1,36 @@
+# ErgoDox EZ 1337 configuration
+
+Custom layout based on the default layout. Intended for interational users of us intl-altgr layout. Note that
+some common keys might be missing, as this layout is intented to be used on *nix systems by users familiar
+with their system. The layout is geared towards avoiding using the rat (mouse for those of you who are
+unfamiliar with tiling window managers) as much as possibly.
+
+# Layouts
+
+All layer images created using [keyboard-layout-editor](http://www.keyboard-layout-editor.com/)
+
+## Base layer
+
+[![Base layer](images/deadcyclo-base-layout.png)](http://www.keyboard-layout-editor.com/#/gists/0321b18620180a3e46c498206eb65366)
+
+## Layer 1 - Symbols
+
+[![Layer 1 - Symbols](images/deadcyclo-layer-1-symbols.png)](http://www.keyboard-layout-editor.com/#/gists/96714e198054c9115bafb5267cc6bc73)
+
+## Layer 2 - Media and Mouse
+
+[![Layer 2 - Media and Mouse](images/deadcyclo-layer-2-media-and-mouse.png)](http://www.keyboard-layout-editor.com/#/gists/824759486e378bcec30784309a7e5731)
+
+## Layer 3 - Navigation
+
+[![Layer 3 - Navigation](images/deadcyclo-layer-3-navigation.png)](http://www.keyboard-layout-editor.com/#/gists/67d9613dcd873c68693d11863d0fd289)
+
+# Changelog
+
+- 02.01.2017 Added delete key on second layer
+- 10.01.2017 Added layer images to readme
+
+# TODO
+
+- Add unicode support (direct input and indirect? see algernon layout for examples)
+- Add descriptions below each layer image of any special functions/keys