From 3eb68339ebc5a7c9e7bb227d3b3bef4bb7862e3f Mon Sep 17 00:00:00 2001 From: Michael Grote <michael.grote@posteo.de> Date: Mon, 18 Mar 2024 11:59:42 +0100 Subject: [PATCH] skeletyl: keymaps in readme, indentation, docs --- .../skeletyl/keymaps/quotengrote/keymap.c | 7 +- .../skeletyl/keymaps/quotengrote/readme.md | 8 -- readme.md | 80 +++++++++++++------ 3 files changed, 57 insertions(+), 38 deletions(-) diff --git a/keyboards/bastardkb/skeletyl/keymaps/quotengrote/keymap.c b/keyboards/bastardkb/skeletyl/keymaps/quotengrote/keymap.c index 40052c1e5d..ee8ed2befd 100644 --- a/keyboards/bastardkb/skeletyl/keymaps/quotengrote/keymap.c +++ b/keyboards/bastardkb/skeletyl/keymaps/quotengrote/keymap.c @@ -7,7 +7,6 @@ void keyboard_post_init_user(void) { rgblight_sethsv(4, 75, 150); // warmhite (werte = hue, saturation, value) rgblight_mode_noeeprom(RGB_MATRIX_SOLID_COLOR); } -// Layer indicator on all keys bool rgb_matrix_indicators_advanced_user(uint8_t led_min, uint8_t led_max) { for (uint8_t i = led_min; i < led_max; i++) { switch(get_highest_layer(layer_state|default_layer_state)) { @@ -91,8 +90,8 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { // Sym - blue [2] = LAYOUT_split_3x5_3( DE_CIRC, DE_LBRC, DE_LPRN, DE_LPRN, DE_SECT, DE_PERC, DE_RCBR, DE_RPRN, DE_RBRC, KC_BSPC, - DE_EXLM, DE_DQUO, LSFT(DE_ACUT ), DE_QUOT, DE_SLSH, RALT(DE_SS), DE_DLR, DE_AMPR, DE_AMPR, DE_QUES, - DE_TILD, XXXXXXX, DE_ACUT , XXXXXXX, DE_LABK , DE_RABK , XXXXXXX, DE_PLUS, DE_EQL, DE_HASH, + DE_EXLM, DE_DQUO, LSFT(DE_ACUT ), DE_QUOT, DE_SLSH, RALT(DE_SS), DE_DLR, DE_AMPR, DE_ASTR, DE_QUES, + DE_TILD, XXXXXXX, DE_ACUT, XXXXXXX, DE_LABK , DE_RABK , XXXXXXX, DE_PLUS, DE_EQL, DE_HASH, XXXXXXX, _______, _______, _______, _______, XXXXXXX ), // Move - green @@ -106,7 +105,7 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { [4] = LAYOUT_split_3x5_3( RGB_TOG, RGB_HUI, RGB_HUD, KC_PSCR, KC_VOLU, KC_VOLU, XXXXXXX, XXXXXXX, XXXXXXX, QK_CAPS_WORD_TOGGLE, RGB_MOD, RGB_SAI, RGB_SAD, XXXXXXX, KC_MUTE, KC_MUTE, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, - RGB_RMOD, RGB_VAI, RGB_VAD, KC_MPLY, KC_VOLD, KC_VOLD, KC_MPLY, XXXXXXX, XXXXXXX, XXXXXXX, + RGB_RMOD, RGB_VAI, RGB_VAD, KC_MPLY, KC_VOLD, KC_VOLD, KC_MPLY, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, _______, _______, _______, _______, XXXXXXX ) diff --git a/keyboards/bastardkb/skeletyl/keymaps/quotengrote/readme.md b/keyboards/bastardkb/skeletyl/keymaps/quotengrote/readme.md index e1ef634f15..3153c1c15b 100644 --- a/keyboards/bastardkb/skeletyl/keymaps/quotengrote/readme.md +++ b/keyboards/bastardkb/skeletyl/keymaps/quotengrote/readme.md @@ -13,11 +13,3 @@ ## "Main Side" - auf links gesetzt in `config.h`, trotzdem müssen beide Seiten geflashed werden - -## ToDo - -- prüfen ob auto shift bei ß stört -- keymap bil anpassen -- maustasten testen -- keymap als bild, und mit combos in repo einchecken, gilt ja für alle tastaturen -- lock layer für movement diff --git a/readme.md b/readme.md index f0e49a08e9..ee14539fba 100644 --- a/readme.md +++ b/readme.md @@ -1,36 +1,64 @@ # Quantum Mechanical Keyboard Firmware -[](https://github.com/qmk/qmk_firmware/tags) -[](https://discord.gg/Uq7gcHh) -[](https://docs.qmk.fm) -[](https://github.com/qmk/qmk_firmware/pulse/monthly) -[](https://github.com/qmk/qmk_firmware/) +## Keymaps -This is a keyboard firmware based on the [tmk\_keyboard firmware](https://github.com/tmk/tmk_keyboard) with some useful features for Atmel AVR and ARM controllers, and more specifically, the [OLKB product line](https://olkb.com), the [ErgoDox EZ](https://ergodox-ez.com) keyboard, and the Clueboard product line. +### Ferris Sweep / BastardKB Skeletyl -## Documentation +``bash -* [See the official documentation on docs.qmk.fm](https://docs.qmk.fm) +Base Layer +------------------------------- ------------------------------- +| Q | W | F | P | B | | J | L | U | Z | BSPC| +------------------------------- ------------------------------- +| A | R | S | T | G | | M | N | E | I | O | +------------------------------- ------------------------------- +| Y | X | C | D | V | | K | H | , | . | - | +------------------------------- ------------------------------- + | | DEL | ENT | | SPC | MOV | | + ------------------- ------------------- -The docs are powered by [Docsify](https://docsify.js.org/) and hosted on [GitHub](/docs/). They are also viewable offline; see [Previewing the Documentation](https://docs.qmk.fm/#/contributing?id=previewing-the-documentation) for more details. +NUM Layer +------------------------------- ------------------------------- +| F1 | F2 | F3 | F4 | F5 | | F6 | F7 | F8 | F9 | BSPC| +------------------------------- ------------------------------- +| 1 | 2 | 3 | 4 | 5 | | 6 | 7 | 8 | 9 | 0 | +------------------------------- ------------------------------- +| Y | X | C | D | V | | F10 | F11 | , | . | F12 | +------------------------------- ------------------------------- + | | DEL | ENT | | SPC | MOV | | + ------------------- ------------------- -You can request changes by making a fork and opening a [pull request](https://github.com/qmk/qmk_firmware/pulls), or by clicking the "Edit this page" link at the bottom of any page. +SYM Layer +------------------------------- ------------------------------- +| ^ | [ | ( | ( | § | | % | } | ) | ] | BSPC| +------------------------------- ------------------------------- +| ! | " | ` | ' | / | | \ | $ | & | * | ? | +------------------------------- ------------------------------- +| ~ | | ´ | | < | | > | | + | = | # | +------------------------------- ------------------------------- + | | DEL | ENT | | SPC | MOV | | + ------------------- ------------------- -## Supported Keyboards +MOV Layer +------------------------------- ------------------------------- +| | HOME| UP | PGUP| | | | PGUP| UP | HOME| BSPC| +------------------------------- ------------------------------- +| TAB | LFT | DW | RGT | | | | LFT | DW | RGT | DEL | +------------------------------- ------------------------------- +| | END | |PGDWN| | | |PGDWN| | END | | +------------------------------- ------------------------------- + | | DEL | ENT | | SPC | MOV | | + ------------------- ------------------- -* [Planck](/keyboards/planck/) -* [Preonic](/keyboards/preonic/) -* [ErgoDox EZ](/keyboards/ergodox_ez/) -* [Clueboard](/keyboards/clueboard/) -* [Cluepad](/keyboards/clueboard/17/) -* [Atreus](/keyboards/atreus/) +MEDIA Layer +------------------------------- ------------------------------- +| RTG | RHUI|RSHUI|PRTSC|VOLUP| |VOLUP| | | |CAPSW| +------------------------------- ------------------------------- +| RMD | RSAI|RSSAI| | MUTE| | MUTE| | | | | +------------------------------- ------------------------------- +| RSMD| RVAI|RSVAI|PLY/P|VOLDW| |VOLDW|PLY/P| | | | +------------------------------- ------------------------------- + | | DEL | ENT | | SPC | MOV | | + ------------------- ------------------- -The project also includes community support for [lots of other keyboards](/keyboards/). - -## Maintainers - -QMK is developed and maintained by Jack Humbert of OLKB with contributions from the community, and of course, [Hasu](https://github.com/tmk). The OLKB product firmwares are maintained by [Jack Humbert](https://github.com/jackhumbert), the Ergodox EZ by [ZSA Technology Labs](https://github.com/zsa), the Clueboard by [Zach White](https://github.com/skullydazed), and the Atreus by [Phil Hagelberg](https://github.com/technomancy). - -## Official Website - -[qmk.fm](https://qmk.fm) is the official website of QMK, where you can find links to this page, the documentation, and the keyboards supported by QMK. +``