aboutsummaryrefslogtreecommitdiffstats
path: root/keyboards/minidox/keymaps/bepo/readme.md
diff options
context:
space:
mode:
authorGravatar Olivier <olivier@codezilla.fr>2020-03-24 01:51:49 +0100
committerGravatar GitHub <noreply@github.com>2020-03-24 00:51:49 +0000
commit8f69983c58e7c8025d55ccdb31bcf570158f5433 (patch)
tree041e5b049020446d9711faf8a92de738927e2dce /keyboards/minidox/keymaps/bepo/readme.md
parentb779078c608292483b40cb13346ff54485e96823 (diff)
downloadqmk_firmware-8f69983c58e7c8025d55ccdb31bcf570158f5433.tar.gz
[Keymap] Minidox Bepo layout (#8515)
* [Keymap] Minidox Bepo layout Todo : Lower Adjust Update Lower E and Lower S on schema * Added config.h * Code review, update config.h Co-Authored-By: Ryan <fauxpark@gmail.com> Co-authored-by: dolie <olivier.ghafari@pm.me> Co-authored-by: Ryan <fauxpark@gmail.com>
Diffstat (limited to 'keyboards/minidox/keymaps/bepo/readme.md')
-rw-r--r--keyboards/minidox/keymaps/bepo/readme.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/keyboards/minidox/keymaps/bepo/readme.md b/keyboards/minidox/keymaps/bepo/readme.md
new file mode 100644
index 000000000..f928c9447
--- /dev/null
+++ b/keyboards/minidox/keymaps/bepo/readme.md
@@ -0,0 +1,31 @@
+# MiniDox Bepo
+
+As the minidox has a restricted number of keys as compared to regular keyboards, some adjustments were made.
+These adjustments allow for improved ergonomics when typing English and programming languages (in particular javascript).
+
+>Keys have been grouped and rearranged to meet the needs of principals programming usages. Most used groups are placed at the opposite of thumb layout-activation key, not to seek the same hand too much:
+ 1. **Arrows/Navigation:** most used with `2.` after standard characters. To navigate comfortably during a long time, the group is placed at the opposite of the thumb-activated layout key.
+ 2. **Programming blocks characters:** most used with `1.` after standard characters. *Group placed at the opposite of the thumb-activated layout key*.
+ 3. **Operators:** less used than navigation. *Same side of the thumb-activated layout key*.
+ 4. **French special characters:** to keep basic characters on main layout and because they are less used in programming and english, french special characters have been moved to a specific layout, counter to Bepo's original main layout. *Same side of the thumb-activated layout key.*
+
+*Here is a list of other ergonomic choices :*
+
+- `Alt` both sides (instead of `AltGr`), as special characters are now handled by layouts, and to comfortably get all shortcuts with both hands (e.g. `alt/tab`...).
+- Numbers on home row, and Function keys on corresponding upper row.
+- Greater/less-than-sign in place of `«` `»`, for easier programming, and because the majority of OS and softwares replace `"` with `«` `»`.
+- Mirror `&` and `|` on little finger, lower row, raise layout (`raiser + &` on little finger is more handy than `raiser + &` on index finger).
+- `’/?` in place of `È` to keep `M` on the right hand side.
+- Better reachability for `W` `Z` `~` `backtick`...
+
+## Firmware :
+[Recent bepo firmware](https://bepo.fr/wiki/Accueil) `1.1rc2` switched generic apostrophe and typographic one.
+As the majority of OS and softwares replace **`'`** with **`’`**, I personnaly do prefer 2008 bepo firmware which keeps generic apostrophe on main layout. In fact, the apostrophe get replaced in text editors, but not in the IDEs while programming.
+Or you also can [switch them by following those instructions.](https://bepo.fr/wiki/Apostrophe)
+
+## Layout :
+![Minidox - Bepo custom layout by dolie](https://user-images.githubusercontent.com/18349922/77227968-f42d9980-6b7b-11ea-9a11-58b1f47842e9.png)
+
+#### N.B.
+I have been using and fine tuned this layout for about a year, and I really enjoy it. 🙂
+