summaryrefslogtreecommitdiff
path: root/keyboards/kbdfans/kbd6x/keymaps/mekberg/readme.md
diff options
context:
space:
mode:
authorEndemoniada <martin@mekberg.se>2019-10-19 02:37:16 +0200
committerDrashna Jaelre <drashna@live.com>2019-10-18 17:37:16 -0700
commit1b1e0977e020b3b381f874144aed31d0664d88d2 (patch)
treedacc24c74d3c1f886a78734017507e28f5378fbd /keyboards/kbdfans/kbd6x/keymaps/mekberg/readme.md
parentd263579781bd550e0ef21a5a102f790afd588c7c (diff)
[Keymap] Mekberg kbd6x keymap (#7061)
* First draft of my layout * Improved layout and cleanup of files * Update keymap and add rules * Add keymap.h with permissive_hold setting * Rename keymap.h to correct name config.h * Add next/prev and special lock key to Fn layer * Use correct modifier in MY_LOCK command * Removed unnecessary filler defines * Add build instructions to README * Move RGB controls to more logical up/down key positions, move next/prev controls, remove del from Fn layer * Fix wrong placeholders and fix up formatting * Remove unused code * Clarify comments on custom defines * Update keyboards/kbdfans/kbd6x/keymaps/mekberg/rules.mk Co-Authored-By: fauxpark <fauxpark@gmail.com>
Diffstat (limited to 'keyboards/kbdfans/kbd6x/keymaps/mekberg/readme.md')
-rw-r--r--keyboards/kbdfans/kbd6x/keymaps/mekberg/readme.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/keyboards/kbdfans/kbd6x/keymaps/mekberg/readme.md b/keyboards/kbdfans/kbd6x/keymaps/mekberg/readme.md
new file mode 100644
index 0000000000..febe2e1d68
--- /dev/null
+++ b/keyboards/kbdfans/kbd6x/keymaps/mekberg/readme.md
@@ -0,0 +1,14 @@
+# General Information
+
+This is more or less a HHKB base layout, but with completely different Fn layers. I don't use most of the HHKB secondary key positions because, honestly, they make no sense to me at all.
+
+Fn key layer is focused mostly on keyboard firmware features (like RGB) as well as some of the necessary alternate functions. It also hold media controls, F-keys and Reset.
+
+Left Tab-Hold layer is focused on nav cluster functionality, and turns Backspace into Delete (and moves Backspace up into the top right 1u position).
+
+
+# Build instructions
+
+To simply build the firmware file: `make clean && make kbdfans/kbd6x:mekberg`
+
+To build and immediately flash: `make clean && make kbdfans/kbd6x:mekberg:dfu`