summaryrefslogtreecommitdiff
path: root/keyboards/planck/keymaps/ishtob/readme.md
diff options
context:
space:
mode:
authorishtob2018-06-26 16:34:01 -0400
committerDrashna Jaelre2018-06-26 13:34:01 -0700
commit482ce08b32fcb4c189f2046894bf1396af1de0e0 (patch)
treee788d627dcf3f25d7ef502ef8872e7507d882169 /keyboards/planck/keymaps/ishtob/readme.md
parent73aed698e828f9d9b95cf09410a4c4428bb1a85e (diff)
Adding ishtob keymap to master (#3235)
* Adding my personal planck keymap * Adding readme.md to my keymap
Diffstat (limited to 'keyboards/planck/keymaps/ishtob/readme.md')
-rw-r--r--keyboards/planck/keymaps/ishtob/readme.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/keyboards/planck/keymaps/ishtob/readme.md b/keyboards/planck/keymaps/ishtob/readme.md
new file mode 100644
index 000000000..22873141f
--- /dev/null
+++ b/keyboards/planck/keymaps/ishtob/readme.md
@@ -0,0 +1,21 @@
+![Planck Layout Image](https://i.imgur.com/yKewjWW.jpg)
+
+#Ishtob's personal planck layout
+
+THis is the default layout used with my planck light, though the rest of the keymap could also be used for the full sized planck or let's split.
+
+
+Main difference with the default layout:
+
+* Tab take the upper left key, made into a Tap layer to access the symbols from the number row
+
+* Esc moved to lower corner
+
+* Capslock is on the base layer as it is used quite often with my work's software
+
+* Numbers layer on lower is positioned to resemble a numpad with 5 taking the location of J for the homing bump and easier entry
+
+
+# Secret Macros
+
+`macros_public.h` contains a list of macros that can be replaced with passwords or other sensative private macros. `macros_private.h` will be used if it exsists in the folder during compiling and will ignore `macros_public.h` The private macros can be excluded from git commits by adding it to the exclusion list.