summaryrefslogtreecommitdiff
path: root/keyboards/lime/keymaps/default/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/lime/keymaps/default/readme.md')
-rw-r--r--keyboards/lime/keymaps/default/readme.md52
1 files changed, 52 insertions, 0 deletions
diff --git a/keyboards/lime/keymaps/default/readme.md b/keyboards/lime/keymaps/default/readme.md
new file mode 100644
index 0000000000..006be983c7
--- /dev/null
+++ b/keyboards/lime/keymaps/default/readme.md
@@ -0,0 +1,52 @@
+## Default layout
+Joystick on the left side, encoder on the right. No underglow.
+
+### Base layer
+![Base layout for Lime Keyboard](https://github.com/HellSingCoder/LimeKeyboard/blob/main/media/base-layer.png?raw=true)
+The layout can be switched for COLEMAK in the settings layer
+
+### Lower layer
+![Lower layout for Lime Keyboard](https://github.com/HellSingCoder/LimeKeyboard/blob/main/media/lower-layer.png?raw=true)
+
+### Raise layer
+![Raise layout for Lime Keyboard](https://github.com/HellSingCoder/LimeKeyboard/blob/main/media/raise-layer.png?raw=true)
+
+### Settings layer
+![Adj layout for Lime Keyboard](https://github.com/HellSingCoder/LimeKeyboard/blob/main/media/adj-layer.png?raw=true)
+
+This layer can be accessed with the following combination:
+
+![Adj layout combination for Lime Keyboard](https://github.com/HellSingCoder/LimeKeyboard/blob/main/media/buttons-layer.png?raw=true)
+
+## Extras
+
+### Keyboard Pet (Luna)
+![Adj layout for Lime Keyboard](https://github.com/HellSingCoder/LimeKeyboard/blob/main/media/luna.gif?raw=true)
+
+Luna jumps every time you hit Space and will bark at people on the internet if you activate Caps Lock!
+
+This keyboard pet reacts to your WPM counter:
+- under 10 -> sit
+- between 10 and 50 -> walk
+- over 50 -> run
+
+### Joystick
+The joystick on the left side will act as a controller for games.
+
+### Shift + Backspace = Delete
+This one is pretty self explanatory.
+
+### Space / Enter swap
+The Enter and Space functions can be swapped pressing the left thumb button from the Setting layer. The current mode will be displayed on the left display. This one may be useful to all the gamers out there!
+
+### OS Switch
+Pressing the OS button while on the settings layer will toggle the MAC / WIN mode. This corrects the behaviour of the Alt and Control modifiers. The current selection will be displayed with an icon at the top of the left display.
+
+### Media Buttons
+The right encoder controls the volume and can be pressed to mute. Extra media buttons are hidden away on the settings layer.
+
+### WPM indicator
+Current WPM will be displayed at the bottom of the right screen.
+
+### Joystick Debug
+The JDebug button on the settings layer toggles the ADC readings of the joystick pins for X and Y axis. These will be displayed on the left OLED.