summaryrefslogtreecommitdiff
path: root/keyboards/ai03/polaris/keymaps/mekberg/readme.md
diff options
context:
space:
mode:
authorEndemoniada <martin@mekberg.se>2020-11-04 22:49:49 +0100
committerGitHub <noreply@github.com>2020-11-04 13:49:49 -0800
commit262a60733483a38ed998b6dc6495f748ba6b71b0 (patch)
treee3e2f47e6a403f1bf62f16f40270a111b326224e /keyboards/ai03/polaris/keymaps/mekberg/readme.md
parent7ef98e7f6164afd1d825a6ce8efa20560927fcc9 (diff)
[Keymap] add ai03/polaris:mekberg (#10508)
* Add keymap for Polaris * Change back to KC_NUBS for <> key * Add GPL header from default files * Change to new way of flashing in readme
Diffstat (limited to 'keyboards/ai03/polaris/keymaps/mekberg/readme.md')
-rw-r--r--keyboards/ai03/polaris/keymaps/mekberg/readme.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/keyboards/ai03/polaris/keymaps/mekberg/readme.md b/keyboards/ai03/polaris/keymaps/mekberg/readme.md
new file mode 100644
index 0000000000..b9ae9642f5
--- /dev/null
+++ b/keyboards/ai03/polaris/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 ai03/polaris:mekberg`
+
+To build and immediately flash: `make clean && make ai03/polaris:mekberg:flash`