summaryrefslogtreecommitdiff
path: root/keyboards/sol/keymaps/default/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/sol/keymaps/default/readme.md')
-rw-r--r--keyboards/sol/keymaps/default/readme.md133
1 files changed, 0 insertions, 133 deletions
diff --git a/keyboards/sol/keymaps/default/readme.md b/keyboards/sol/keymaps/default/readme.md
deleted file mode 100644
index f5f3845551..0000000000
--- a/keyboards/sol/keymaps/default/readme.md
+++ /dev/null
@@ -1,133 +0,0 @@
-# The Default Sol Layout
-## Layout
-
-### Base modifier layout
-```
- * ,------------------------------------------------. ,------------------------------------------------.
- * | GESC | | | | | | - | | = | | | | | | BkSp |
- * |------+------+------+------+------+------|------| |------|------+------+------+------+------+------|
- * | Tab | | | | | | [ | | ] | | | | | | \ |
- * |------+------+------+------+------+------|------| |------|------+------+------+------+------+------|
- * |FN(CAPS)| | | | | | ( | | ) | | | | | | ' |
- * |------+------+------+------+------+------+------| |------+------+------+------+------+------+------|
- * |Shift | | | | | | { | | } | | | | | |Shift |
- * |------+------+------+------+------+------+------| |------+------+------+------+------+------+------|
- * | Ctrl | Win | Alt | RGB | ADJ | Space| DEL | | Enter| Space| FN | Left | Down | Up |Right |
- * |------+------+------+------+------+------+------| |------+------+------+------+------+------+------'
- * | Space| DEL | | Enter| Space|
- * `-------------' `-------------'
-```
-
-### Qwerty alphas
-```
- * ,------------------------------------------------. ,------------------------------------------------.
- * | | | | | | | | | | | | | | | |
- * |------+------+------+------+------+------|------| |------|------+------+------+------+------+------|
- * | | Q | W | E | R | T | | | | Y | U | I | O | P | |
- * |------+------+------+------+------+------|------| |------|------+------+------+------+------+------|
- * | | A | S | D | F | G | | | | H | J | K | L | ; | |
- * |------+------+------+------+------+------+------| |------+------+------+------+------+------+------|
- * | | Z | X | C | V | B | | | | N | M | , | . | / | |
- * |------+------+------+------+------+------+------| |------+------+------+------+------+------+------|
- * | | | | | | | | | | | | | | | |
- * `------+------+------+------+------+------+------| |------+------+------+------+------+------+------'
- * | | | | | |
- * `-------------' `-------------'
-```
-
-### Colemak alphas
-```
- * ,------------------------------------------------. ,------------------------------------------------.
- * | | | | | | | | | | | | | | | |
- * |------+------+------+------+------+------|------| |------|------+------+------+------+------+------|
- * | | Q | W | F | P | B | | | | J | L | U | Y | ; | |
- * |------+------+------+------+------+------|------| |------|------+------+------+------+------+------|
- * | | A | R | S | T | G | | | | K | N | E | I | O | |
- * |------+------+------+------+------+------+------| |------+------+------+------+------+------+------|
- * | | Z | X | C | D | V | | | | M | H | , | . | / | |
- * |------+------+------+------+------+------+------| |------+------+------+------+------+------+------|
- * | | | | | | | | | | | | | | | |
- * `------+------+------+------+------+------+------| |------+------+------+------+------+------+------'
- * | | | | | |
- * `-------------' `-------------'
-```
-
-### Function (FN)
-```
- * ,------------------------------------------------. ,------------------------------------------------.
- * | F1 | F2 | F3 | F4 | F5 | F6 | | | | F7 | F8 | F9 | F10 | F11 | F12 |
- * |------+------+------+------+------+------|------| |------|------+------+------+------+------+------|
- * | | PGDN | UP | PGUP | | | | | | | PGDN | UP | PGUP | PRINT| HOME |
- * |------+------+------+------+------+------|------| |------|------+------+------+------+------+------|
- * | | LEFT | DOWN | RIGHT| | | | | | | LEFT | DOWN | RIGHT|INSERT| END |
- * |------+------+------+------+------+------+------| |------+------+------+------+------+------+------|
- * | | | | | | | | | | | | | | | |
- * |------+------+------+------+------+------+------| |------+------+------+------+------+------+------|
- * | | | |RGBMOD| | | | | | | PLAY | NEXT | MUTE | VOL- | VOL+ |
- * `------+------+------+------+------+------+------| |------+------+------+------+------+------+------'
- * | | | | | |
- * `-------------' `-------------'
-```
-
-### Adjust (ADJ)
-```
- * ,------------------------------------------------. ,------------------------------------------------.
- * | F1 | F2 | F3 | F4 | F5 | F6 | | | | F7 | F8 | F9 | F10 | F11 | F12 |
- * |------+------+------+------+------+------|------| |------|------+------+------+------+------+------|
- * | | SAD | VAI | SAI | RESET| | | | | | | | | | |
- * |------+------+------+------+------+------|------| |------|------+------+------+------+------+------|
- * | | HUD | VAD | HUI |RGBRST| | | | | |QWERTY|COLEMK| | | |
- * |------+------+------+------+------+------+------| |------+------+------+------+------+------+------|
- * | | | | | | | | | | | |RGBTOG| HUI | SAI | VAI |
- * |------+------+------+------+------+------+------| |------+------+------+------+------+------+------|
- * | | | |RGBMOD| | | | | | | |RGBSMOD| HUD | SAD | VAD |
- * `------+------+------+------+------+------+------| |------+------+------+------+------+------+------'
- * | | | | | |
- * `-------------' `-------------'
-```
-
-## Customize
-
-see `qmk_firmware/keyboards/sol/rev1/keymaps/default/rules.mk`
-
-```
-
-# Variables you can set for SOL
-
-BOOTMAGIC_ENABLE = no # Virtual DIP switch configuration(+1000)
-MOUSEKEY_ENABLE = no # Mouse keys(+4700)
-EXTRAKEY_ENABLE = yes # Audio control and System control(+450)
-CONSOLE_ENABLE = yes # Console for debug(+400)
-COMMAND_ENABLE = yes # Commands for debug and configuration
-NKRO_ENABLE = no # Nkey Rollover - if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work
-RGBLIGHT_ENABLE = yes # Enable global lighting effects. Do not enable with RGB Matrix
-LED_ANIMATIONS = yes # LED animations
-LED_MIRRORED = no # Mirror LEDs across halves (enable DIP 1 on slave, and DIP 2 and 3 on master)
-RGB_MATRIX_ENABLE = no # Enable per-key coordinate based RGB effects. Do not enable with RGBlight (+8500)
-RGB_MATRIX_KEYPRESSES = no # Enable reactive per-key effects. Can be very laggy (+1500)
-RGBLIGHT_FULL_POWER = no # Allow maximum RGB brightness. Otherwise, limited to a safe level for a normal USB-A port
-UNICODE_ENABLE = no # Unicode
-SWAP_HANDS_ENABLE = no # Enable one-hand typing
-ENCODER_ENABLE_CUSTOM = yes # Enable rotary encoder (+90)
-
-OLED_ENABLE = no # OLED_ENABLE (+5000)
-IOS_DEVICE_ENABLE = no # Limit max brightness to connect to IOS device (iPad,iPhone)
-
-
-```
-## Compile
-
-go to qmk top directory.
-```
-$ cd qmk_firmware
-```
-
-build
-```
-$ make sol:default
-```
-
-After the initial flash with AVRdudess, you should be able to flash using this:
-```
-$ make sol:default:dfu
-```