summaryrefslogtreecommitdiff
path: root/keyboards/splitkb/aurora/sweep/keymaps/flinguenheld/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/splitkb/aurora/sweep/keymaps/flinguenheld/readme.md')
-rw-r--r--keyboards/splitkb/aurora/sweep/keymaps/flinguenheld/readme.md130
1 files changed, 130 insertions, 0 deletions
diff --git a/keyboards/splitkb/aurora/sweep/keymaps/flinguenheld/readme.md b/keyboards/splitkb/aurora/sweep/keymaps/flinguenheld/readme.md
new file mode 100644
index 0000000000..3873ca45cf
--- /dev/null
+++ b/keyboards/splitkb/aurora/sweep/keymaps/flinguenheld/readme.md
@@ -0,0 +1,130 @@
+### Custom aurora sweep keymap
+
+
+This keymap is inspired by [optimot](https://bepo.fr/) which is a French layout.
+Nonetheless all French characters are sent in unicode, so it works with the standard US ANSI layout.
+
+It uses the *best* qmk features :
+- combos ♥
+- auto shift
+- leader
+
+I tried to optimise key positions for neovim and i3wm while limit digrams.
+The oled screens are used to display the current layout, the modifier keys and the leader key.
+
+![oledmodifiers](https://i.imgur.com/on95jx0.png)
+![oledmouse](https://i.imgur.com/PwkR6P2.png)
+
+#### Install
+
+Clone this repo in the folder :
+
+ ~/qmk_firmware/keyboards/splitkb/aurora/sweep/keymaps/
+
+#### Compile and flash
+
+Navigate into the keymap folder and launch this command for both sides :
+
+ qmk compile && qmk flash
+
+and :
+
+ Click twice on the flash button and use nautilus for instance to clic on the keyboard.
+ Don't forget to flash with the double tap bootloader define before soldering.
+
+#### Links
+
+[qmk](https://docs.qmk.fm/#/)
+[ferris sweep](https://github.com/davidphilipbarr/Sweep)
+[splitkb](https://splitkb.com)
+
+#### Layouts
+
+![base](https://i.imgur.com/E3hRkxW.png)
+![numeric](https://i.imgur.com/GeC0reE.png)
+![mouse](https://i.imgur.com/QhsWVrE.png)
+![arrows](https://i.imgur.com/4sAfGAt.png)
+![adjust](https://i.imgur.com/hcoN2P8.png)
+![fn](https://i.imgur.com/dVunqFF.png)
+![left hand](https://i.imgur.com/fk5YJj6.png)
+![combo](https://i.imgur.com/aZ8TpuY.png)
+![combo2](https://i.imgur.com/QayRuFA.png)
+![combo3](https://i.imgur.com/YpnbMeh.png)
+
+#### French
+
+| - | |
+|------------------|------------------------|
+| space + e | é |
+| space + i | ç |
+| space + a | æ |
+| space + o | œ |
+| comma + a | à |
+| comma + e | è |
+| comma + i | ì |
+| comma + o | ò |
+| comma + u | ù |
+| enter + a | â |
+| enter + e | ê |
+| enter + i | î |
+| enter + o | ô |
+| enter + u | û |
+| dot + a | ä |
+| dot + e | ë |
+| dot + i | ï |
+| dot + o | ö |
+| dot + u | ü |
+| dot + y | ÿ |
+
+
+#### Leader
+
+| - | |
+|--------------------|------------------------|
+| M + S | mail short |
+| M + L | mail long |
+| D + E + G | ° |
+| C + O + P | © |
+| R + E + G | ® |
+| D + I + A | ø |
+| D + I + A + M | Ø |
+| E + U + R | € |
+| P + O + U | £ |
+| Y + E + N | ¥ |
+| C + E + N | ¢ |
+| P + I | π |
+| P + I + I | Π |
+| O + M + E | ω |
+| O + M + E + G | Ω |
+| U + P + F | ⁰ |
+| D + N + F | ₀ |
+
+| - | |
+|--------------------|------------------------|
+| M + U + L | × |
+| D + I + V | ÷ |
+| P + M | ± |
+| I + N + E | ≠ |
+| A + L + M | ≈ |
+| S + Q + U | √ |
+| I + N + F | ∞ |
+| < + < | ≤ |
+| > + > | ≥ |
+| F + S + T | ¼ |
+| F + S + G | ½ |
+| F + H + T | ¾ |
+
+| - | |
+|--------------------|------------------------|
+| F + L + A | ⚡ |
+| S + P + A | ✨ |
+| O + W + D | ⛔ |
+| C + O + F | ☕ |
+| U + M + B | ☔ |
+| Y + E + S | ✅ |
+| N + O | ❎ |
+| C + R + O | ❌ |
+| ? | ❔ |
+| ! | ❕ |
+| ? + ? | ❓ |
+| ! + ! | ❗ |