Fix install for Linux Ubuntu (#7520 )

* Fix linux install for Ubuntu. It failed due to sh not supporting [ and pip being seperate from python3 * Adapted install function according to feedback * Fix style
Add pep8-naming to our python linting
2026-06-24 16:24:34 -04:00 · 2019-12-02 08:56:38 +11:00 · 2019-12-01 13:40:14 -08:00 · 2019-12-01 12:54:57 -08:00 · 2019-12-01 16:23:14 +00:00 · 2019-12-01 08:20:45 -08:00
277 changed files with 11459 additions and 2875 deletions
@@ -18,7 +18,7 @@ pulls:
    activity in the last 45 days. It will be closed in 30 days if no further activity occurs.
    Please feel free to give a status update now, or re-open when it's ready.
    
-    For maintainers: Please label with `awaiting review`, `breaking_change`, `in progress, or `on hold` to prevent 
+    For maintainers: Please label with `awaiting review`, `breaking_change`, `in progress`, or `on hold` to prevent 
    the issue from being re-flagged.
  # Comment to post when closing a stale Issue or Pull Request.
  closeComment: >
@@ -45,7 +45,7 @@ issues:
    last 90 days. It will be closed in the next 30 days unless it is tagged properly or other activity
    occurs.
    
-    For maintainers: Please label with `bug`, `in progress`, `on hold`, discussion` or `to do` to prevent 
+    For maintainers: Please label with `bug`, `in progress`, `on hold`, `discussion` or `to do` to prevent 
    the issue from being re-flagged.
  closeComment: >
    This issue has been automatically closed because it has not had activity in the last 30 days.
@@ -25,6 +25,11 @@ with open(os.path.join(qmk_dir, 'requirements.txt'), 'r') as fd:
            line = line.split('#')[0]

        module = line.split('=')[0] if '=' in line else line
+
+        if module in ['pep8-naming']:
+            # Not every module is importable by its own name.
+            continue
+
        if not find_spec(module):
            print('Could not find module %s!' % module)
            print('Please run `pip3 install -r requirements.txt` to install the python dependencies.')
@@ -111,7 +111,7 @@
  * [Using Eclipse with QMK](other_eclipse.md)
  * [Using VSCode with QMK](other_vscode.md)
  * [Support](support.md)
-  * [How to add translations](translating.md)
+  * [Translating the QMK Docs](translating.md)

 * QMK Internals (In Progress)
  * [Defines](internals_defines.md)
@@ -101,6 +101,18 @@ enum my_keycodes {
 };
 ```

+### Previewing the Documentation
+
+Before opening a pull request, you can preview your changes if you have set up the development environment by running this command from the `qmk_firmware/` folder:
+
+    ./bin/qmk docs
+
+or if you only have Python 3 installed:
+
+    python3 -m http.server 8936
+
+and navigating to `http://localhost:8936/`.
+
 ## Keymaps

 Most first-time QMK contributors start with their personal keymaps. We try to keep keymap standards pretty casual (keymaps, after all, reflect the personality of their creators) but we do ask that you follow these guidelines to make it easier for others to discover and learn from your keymap.
@@ -114,7 +114,15 @@ Two more deprecated functions exist that provide the LED state as a `uint8_t`:

 This function will be called when the state of one of those 5 LEDs changes. It receives the LED state as a struct parameter.

-You must return either `true` or `false` from this function, depending on whether you want to override the keyboard-level implementation.
+By convention, return `true` from `led_update_user()` to get the `led_update_kb()` hook to run its code, and
+return `false` when you would prefer not to run the code in `led_update_kb()`.
+
+Some examples include:
+
+  - overriding the LEDs to use them for something else like layer indication
+    - return `false` because you do not want the `_kb()` function to run, as it would override your layer behavior.
+  - play a sound when an LED turns on or off.
+    - return `true` because you want the `_kb` function to run, and this is in addition to the default LED behavior.

 ?> Because the `led_set_*` functions return `void` instead of `bool`, they do not allow for overriding the keyboard LED control, and thus it's recommended to use `led_update_*` instead.

@@ -122,66 +130,41 @@ You must return either `true` or `false` from this function, depending on whethe

 ```c
 bool led_update_kb(led_t led_state) {
-    if(led_update_user(led_state)) {
-        if (led_state.num_lock) {
-            writePinLow(B0);
-        } else {
-            writePinHigh(B0);
-        }
-        if (led_state.caps_lock) {
-            writePinLow(B1);
-        } else {
-            writePinHigh(B1);
-        }
-        if (led_state.scroll_lock) {
-            writePinLow(B2);
-        } else {
-            writePinHigh(B2);
-        }
-        if (led_state.compose) {
-            writePinLow(B3);
-        } else {
-            writePinHigh(B3);
-        }
-        if (led_state.kana) {
-            writePinLow(B4);
-        } else {
-            writePinHigh(B4);
-        }
-        return true;
+    bool res = led_update_user(led_state);
+    if(res) {
+        // writePin sets the pin high for 1 and low for 0.
+        // In this example the pins are inverted, setting
+        // it low/0 turns it on, and high/1 turns the LED off.
+        // This behavior depends on whether the LED is between the pin
+        // and VCC or the pin and GND.
+        writePin(B0, !led_state.num_lock);
+        writePin(B1, !led_state.caps_lock);
+        writePin(B2, !led_state.scroll_lock);
+        writePin(B3, !led_state.compose);
+        writePin(B4, !led_state.kana);
    }
+    return res;
 }
 ```

 ### Example `led_update_user()` Implementation

+This incomplete example would play a sound if Caps Lock is turned on or off. It returns `true`, because you also want the LEDs to maintain their state.
+
 ```c
+#ifdef AUDIO_ENABLE
+  float caps_on[][2] = SONG(CAPS_LOCK_ON_SOUND);
+  float caps_off[][2] = SONG(CAPS_LOCK_OFF_SOUND);
+#endif
+
 bool led_update_user(led_t led_state) {
-    if (led_state.num_lock) {
-        writePinLow(B0);
-    } else {
-        writePinHigh(B0);
-    }
-    if (led_state.caps_lock) {
-        writePinLow(B1);
-    } else {
-        writePinHigh(B1);
-    }
-    if (led_state.scroll_lock) {
-        writePinLow(B2);
-    } else {
-        writePinHigh(B2);
-    }
-    if (led_state.compose) {
-        writePinLow(B3);
-    } else {
-        writePinHigh(B3);
-    }
-    if (led_state.kana) {
-        writePinLow(B4);
-    } else {
-        writePinHigh(B4);
+    #ifdef AUDIO_ENABLE
+    static uint8_t caps_state = 0;
+    if (caps_state != led_state.caps_lock) {
+        led_state.caps_lock ? PLAY_SONG(caps_on) : PLAY_SONG(caps_off);
+        caps_state = led_state.caps_lock;
    }
+    #endif
    return true;
 }
 ```
@@ -411,7 +394,7 @@ void keyboard_post_init_user(void) {
  // Set default layer, if enabled
  if (user_config.rgb_layer_change) {
    rgblight_enable_noeeprom();
-    rgblight_sethsv_noeeprom_cyan(); 
+    rgblight_sethsv_noeeprom_cyan();
    rgblight_mode_noeeprom(1);
  }
 }
@@ -459,18 +442,18 @@ bool process_record_user(uint16_t keycode, keyrecord_t *record) {
        }
        return true; // Let QMK send the enter press/release events
    case RGB_LYR:  // This allows me to use underglow as layer indication, or as normal
-        if (record->event.pressed) { 
+        if (record->event.pressed) {
            user_config.rgb_layer_change ^= 1; // Toggles the status
            eeconfig_update_user(user_config.raw); // Writes the new status to EEPROM
-            if (user_config.rgb_layer_change) { // if layer state indication is enabled, 
+            if (user_config.rgb_layer_change) { // if layer state indication is enabled,
                layer_state_set(layer_state);   // then immediately update the layer color
            }
        }
        return false; break;
    case RGB_MODE_FORWARD ... RGB_MODE_GRADIENT: // For any of the RGB codes (see quantum_keycodes.h, L400 for reference)
        if (record->event.pressed) { //This disables layer indication, as it's assumed that if you're changing this ... you want that disabled
-            if (user_config.rgb_layer_change) {        // only if this is enabled 
-                user_config.rgb_layer_change = false;  // disable it, and 
+            if (user_config.rgb_layer_change) {        // only if this is enabled
+                user_config.rgb_layer_change = false;  // disable it, and
                eeconfig_update_user(user_config.raw); // write the setings to EEPROM
            }
        }
@@ -483,7 +466,7 @@ bool process_record_user(uint16_t keycode, keyrecord_t *record) {
 And lastly, you want to add the `eeconfig_init_user` function, so that when the EEPROM is reset, you can specify default values, and even custom actions. To force an EEPROM reset, use the `EEP_RST` keycode or [Bootmagic](feature_bootmagic.md) functionallity. For example, if you want to set rgb layer indication by default, and save the default valued. 

 ```c
-void eeconfig_init_user(void) {  // EEPROM is getting reset! 
+void eeconfig_init_user(void) {  // EEPROM is getting reset!
  user_config.raw = 0;
  user_config.rgb_layer_change = true; // We want this enabled by default
  eeconfig_update_user(user_config.raw); // Write default value to EEPROM now
@@ -508,7 +491,7 @@ The `val` is the value of the data that you want to write to EEPROM.  And the `e

 By default, the tapping term is defined globally, and is not configurable by key.  For most users, this is perfectly fine.  But in come cases, dual function keys would be greatly improved by different timeouts than `LT` keys, or because some keys may be easier to hold than others.  Instead of using custom key codes for each, this allows for per key configurable `TAPPING_TERM`.

-To enable this functionality, you need to add `#define TAPPING_TERM_PER_KEY` to your `config.h`, first.  
+To enable this functionality, you need to add `#define TAPPING_TERM_PER_KEY` to your `config.h`, first. 


 ## Example `get_tapping_term` Implementation
@@ -111,7 +111,7 @@
  * [Support](de/support.md)
  * [Übersetzungen](de/translating.md)

-* QMK Internals (de/In Progress)
+* QMK Internals (In Progress)
  * [Defines](de/internals_defines.md)
  * [Input Callback Reg](de/internals_input_callback_reg.md)
  * [Midi Device](de/internals_midi_device.md)
@@ -19,7 +19,7 @@ De cualquier manera, también puedes descargarlo directamente en formatos ([zip]

 ## Cómo compilar

-Antes de poder compilar, necesitarás [instalar un entorno](getting_started_build_tools.md) para el desarrollo de AVR y/o ARM. Una vez hayas completado este paso, usarás el comando `make` para compilar un teclado y keymap con la siguiente notación:
+Antes de poder compilar, necesitarás [instalar un entorno](es/getting_started_build_tools.md) para el desarrollo de AVR y/o ARM. Una vez hayas completado este paso, usarás el comando `make` para compilar un teclado y keymap con la siguiente notación:

    make planck/rev4:default

@@ -29,4 +29,4 @@ Este ejemplo compilaría la revisión `rev4` del teclado `planck` con el keymap

 ## Cómo personalizar

-QMK tiene montones de [características](features.md) para explorar, y una buena cantidad de [documentación de referencia](http://docs.qmk.fm) en la que sumergirse. Se pueden sacar provecho de la mayoría de las características modificando tu [keymap](keymap.md), y cambiando los [keycodes](keycodes.md).
+QMK tiene montones de [características](es/features.md) para explorar, y una buena cantidad de [documentación de referencia](http://docs.qmk.fm) en la que sumergirse. Se pueden sacar provecho de la mayoría de las características modificando tu [keymap](es/keymap.md), y cambiando los [keycodes](es/keycodes.md).
@@ -1,121 +1,121 @@
-* [Guía completa para novatos](newbs.md)
-  * [Empezando](newbs_getting_started.md)
-  * [Construyendo tu primer firmare](newbs_building_firmware.md)
-  * [Flasheando el firmware](newbs_flashing.md)
-  * [Testeando y depurando ](newbs_testing_debugging.md)
-  * [Mejores práticas](newbs_best_practices.md)
-  * [Recursos de aprendizaje](newbs_learn_more_resources.md)
+* [Guía completa para novatos](es/newbs.md)
+  * [Empezando](es/newbs_getting_started.md)
+  * [Construyendo tu primer firmare](es/newbs_building_firmware.md)
+  * [Flasheando el firmware](es/newbs_flashing.md)
+  * [Testeando y depurando ](es/newbs_testing_debugging.md)
+  * [Mejores práticas](es/newbs_best_practices.md)
+  * [Recursos de aprendizaje](es/newbs_learn_more_resources.md)

-* [QMK Basics](README.md)
-  * [Introducción a QMK](getting_started_introduction.md)
-  * [QMK CLI](cli.md)
-  * [Configuración de QMK CLI](cli_configuration.md)
-  * [Contribuyendo a QMK](contributing.md)
-  * [Cómo usar Github](getting_started_github.md)
-  * [Obtener ayuda](getting_started_getting_help.md)
+* [QMK Basics](es/README.md)
+  * [Introducción a QMK](es/getting_started_introduction.md)
+  * [QMK CLI](es/cli.md)
+  * [Configuración de QMK CLI](es/cli_configuration.md)
+  * [Contribuyendo a QMK](es/contributing.md)
+  * [Cómo usar Github](es/getting_started_github.md)
+  * [Obtener ayuda](es/getting_started_getting_help.md)

-* [Cambios incompatibles](breaking_changes.md)
-  * [30 Ago 2019](ChangeLog/20190830.md)
+* [Cambios incompatibles](es/breaking_changes.md)
+  * [30 Ago 2019](es/ChangeLog/20190830.md)

-* [Preguntas frecuentes](faq.md)
-  * [General](faq_general.md)
-  * [Construir/Compilar QMK](faq_build.md)
-  * [Depurando/Encontrando problemas en QMK](faq_debug.md)
-  * [Keymap](faq_keymap.md)
-  * [Instalación de drivers con Zadig](driver_installation_zadig.md)
+* [Preguntas frecuentes](es/faq.md)
+  * [General](es/faq_general.md)
+  * [Construir/Compilar QMK](es/faq_build.md)
+  * [Depurando/Encontrando problemas en QMK](es/faq_debug.md)
+  * [Keymap](es/faq_keymap.md)
+  * [Instalación de drivers con Zadig](es/driver_installation_zadig.md)

 * Guías detalladas
-  * [Instalar herramientas construcción](getting_started_build_tools.md)
-  * [Guía Vagrant](getting_started_vagrant.md)
-  * [Instrucciones de Construcción/Compilado](getting_started_make_guide.md)
-  * [Flasheando Firmware](flashing.md)
-  * [Personalizando funcionalidad](custom_quantum_functions.md)
-  * [Visión general del Keymap](keymap.md)
+  * [Instalar herramientas construcción](es/getting_started_build_tools.md)
+  * [Guía Vagrant](es/getting_started_vagrant.md)
+  * [Instrucciones de Construcción/Compilado](es/getting_started_make_guide.md)
+  * [Flasheando Firmware](es/flashing.md)
+  * [Personalizando funcionalidad](es/custom_quantum_functions.md)
+  * [Visión general del Keymap](es/keymap.md)

-* [Hardware](hardware.md)
-  * [Procesadores AVR](hardware_avr.md)
-  * [Drivers](hardware_drivers.md)
+* [Hardware](es/hardware.md)
+  * [Procesadores AVR](es/hardware_avr.md)
+  * [Drivers](es/hardware_drivers.md)

 * Referencia
-  * [Pautas de teclados](hardware_keyboard_guidelines.md)
-  * [Opciones de configuración](config_options.md)
-  * [Keycodes](keycodes.md)
-  * [Convenciones de código - C](coding_conventions_c.md)
-  * [Convenciones de código - Python](coding_conventions_python.md)
-  * [Mejores prácticas de documentación](documentation_best_practices.md)
-  * [Plantillas de documentación](documentation_templates.md)
-  * [Glosario](reference_glossary.md)
-  * [Tests unitarios](unit_testing.md)
-  * [Funciones útiles](ref_functions.md)
-  * [Sporte configurador](reference_configurator_support.md)
-  * [Formato info.json](reference_info_json.md)
-  * [Desarrollo Python CLI](cli_development.md)
+  * [Pautas de teclados](es/hardware_keyboard_guidelines.md)
+  * [Opciones de configuración](es/config_options.md)
+  * [Keycodes](es/keycodes.md)
+  * [Convenciones de código - C](es/coding_conventions_c.md)
+  * [Convenciones de código - Python](es/coding_conventions_python.md)
+  * [Mejores prácticas de documentación](es/documentation_best_practices.md)
+  * [Plantillas de documentación](es/documentation_templates.md)
+  * [Glosario](es/reference_glossary.md)
+  * [Tests unitarios](es/unit_testing.md)
+  * [Funciones útiles](es/ref_functions.md)
+  * [Sporte configurador](es/reference_configurator_support.md)
+  * [Formato info.json](es/reference_info_json.md)
+  * [Desarrollo Python CLI](es/cli_development.md)

-* [Características](features.md)
-  * [Keycodes Básicos](keycodes_basic.md)
-  * [Teclas US ANSI Shifted](keycodes_us_ansi_shifted.md)
-  * [Keycodes Quantum](quantum_keycodes.md)
-  * [Keycodes Avanzados](feature_advanced_keycodes.md)
-  * [Audio](feature_audio.md)
-  * [Auto Shift](feature_auto_shift.md)
-  * [Retroiluminación](feature_backlight.md)
-  * [Bluetooth](feature_bluetooth.md)
-  * [Bootmagic](feature_bootmagic.md)
-  * [Combos](feature_combo.md)
-  * [Comando](feature_command.md)
-  * [API Debounce](feature_debounce_type.md)
-  * [Switch DIP](feature_dip_switch.md)
-  * [Macros Dinámicas](feature_dynamic_macros.md)
-  * [Encoders](feature_encoders.md)
-  * [Grave Escape](feature_grave_esc.md)
-  * [Feedback Háptico](feature_haptic_feedback.md)
-  * [Controlador LCD HD44780](feature_hd44780.md)
-  * [Key Lock](feature_key_lock.md)
-  * [Layouts](feature_layouts.md)
-  * [Tecla Leader](feature_leader_key.md)
-  * [Matriz LED](feature_led_matrix.md)
-  * [Macros](feature_macros.md)
-  * [Teclas del ratón](feature_mouse_keys.md)
-  * [Driver OLED](feature_oled_driver.md)
-  * [Teclas One Shot](feature_advanced_keycodes.md#one-shot-keys)
-  * [Dispositivo de apuntado](feature_pointing_device.md)
-  * [Ratón PS/2](feature_ps2_mouse.md)
-  * [Iluminación RGB](feature_rgblight.md)
-  * [Matriz RGB](feature_rgb_matrix.md)
-  * [Cadete espacial](feature_space_cadet.md)
-  * [Teclado dividido](feature_split_keyboard.md)
-  * [Stenografía](feature_stenography.md)
-  * [Swap Hands](feature_swap_hands.md)
-  * [Tap Dance](feature_tap_dance.md)
-  * [Terminal](feature_terminal.md)
-  * [Impresora Térmica](feature_thermal_printer.md)
-  * [Unicode](feature_unicode.md)
-  * [Userspace](feature_userspace.md)
-  * [Velocikey](feature_velocikey.md)
+* [Características](es/features.md)
+  * [Keycodes Básicos](es/keycodes_basic.md)
+  * [Teclas US ANSI Shifted](es/keycodes_us_ansi_shifted.md)
+  * [Keycodes Quantum](es/quantum_keycodes.md)
+  * [Keycodes Avanzados](es/feature_advanced_keycodes.md)
+  * [Audio](es/feature_audio.md)
+  * [Auto Shift](es/feature_auto_shift.md)
+  * [Retroiluminación](es/feature_backlight.md)
+  * [Bluetooth](es/feature_bluetooth.md)
+  * [Bootmagic](es/feature_bootmagic.md)
+  * [Combos](es/feature_combo.md)
+  * [Comando](es/feature_command.md)
+  * [API Debounce](es/feature_debounce_type.md)
+  * [Switch DIP](es/feature_dip_switch.md)
+  * [Macros Dinámicas](es/feature_dynamic_macros.md)
+  * [Encoders](es/feature_encoders.md)
+  * [Grave Escape](es/feature_grave_esc.md)
+  * [Feedback Háptico](es/feature_haptic_feedback.md)
+  * [Controlador LCD HD44780](es/feature_hd44780.md)
+  * [Key Lock](es/feature_key_lock.md)
+  * [Layouts](es/feature_layouts.md)
+  * [Tecla Leader](es/feature_leader_key.md)
+  * [Matriz LED](es/feature_led_matrix.md)
+  * [Macros](es/feature_macros.md)
+  * [Teclas del ratón](es/feature_mouse_keys.md)
+  * [Driver OLED](es/feature_oled_driver.md)
+  * [Teclas One Shot](es/feature_advanced_keycodes.md#one-shot-keys)
+  * [Dispositivo de apuntado](es/feature_pointing_device.md)
+  * [Ratón PS/2](es/feature_ps2_mouse.md)
+  * [Iluminación RGB](es/feature_rgblight.md)
+  * [Matriz RGB](es/feature_rgb_matrix.md)
+  * [Cadete espacial](es/feature_space_cadet.md)
+  * [Teclado dividido](es/feature_split_keyboard.md)
+  * [Stenografía](es/feature_stenography.md)
+  * [Swap Hands](es/feature_swap_hands.md)
+  * [Tap Dance](es/feature_tap_dance.md)
+  * [Terminal](es/feature_terminal.md)
+  * [Impresora Térmica](es/feature_thermal_printer.md)
+  * [Unicode](es/feature_unicode.md)
+  * [Userspace](es/feature_userspace.md)
+  * [Velocikey](es/feature_velocikey.md)

 * Para Makers y Modders
-  * [Guía de cableado a mano](hand_wire.md)
-  * [Guía de flasheado de ISP](isp_flashing_guide.md)
-  * [Guía de depuración de ARM](arm_debugging.md)
-  * [Driver I2C](i2c_driver.md)
-  * [Controles GPIO](internals_gpio_control.md)
-  * [Conversión Proton C](proton_c_conversion.md)
+  * [Guía de cableado a mano](es/hand_wire.md)
+  * [Guía de flasheado de ISP](es/isp_flashing_guide.md)
+  * [Guía de depuración de ARM](es/arm_debugging.md)
+  * [Driver I2C](es/i2c_driver.md)
+  * [Controles GPIO](es/internals_gpio_control.md)
+  * [Conversión Proton C](es/proton_c_conversion.md)

 * Para entender en profundidad
-  * [Cómo funcionan los teclados](how_keyboards_work.md)
-  * [Entendiendo QMK](understanding_qmk.md)
+  * [Cómo funcionan los teclados](es/how_keyboards_work.md)
+  * [Entendiendo QMK](es/understanding_qmk.md)

 * Otros temas
-  * [Usando Eclipse con QMK](other_eclipse.md)
-  * [Usando VSCode con QMK](other_vscode.md)
-  * [Soporte](support.md)
-  * [Cómo añadir traducciones](translating.md)
+  * [Usando Eclipse con QMK](es/other_eclipse.md)
+  * [Usando VSCode con QMK](es/other_vscode.md)
+  * [Soporte](es/support.md)
+  * [Cómo añadir traducciones](es/translating.md)

 * QMK Internals (En progreso)
-  * [Defines](internals_defines.md)
-  * [Input Callback Reg](internals_input_callback_reg.md)
-  * [Dispositivo Midi](internals_midi_device.md)
-  * [Proceso de configuración de un dispositivo Midi](internals_midi_device_setup_process.md)
-  * [Utilidad Midi](internals_midi_util.md)
-  * [Funciones Send](internals_send_functions.md)
-  * [Herramientas Sysex](internals_sysex_tools.md)
+  * [Defines](es/internals_defines.md)
+  * [Input Callback Reg](es/internals_input_callback_reg.md)
+  * [Dispositivo Midi](es/internals_midi_device.md)
+  * [Proceso de configuración de un dispositivo Midi](es/internals_midi_device_setup_process.md)
+  * [Utilidad Midi](es/internals_midi_util.md)
+  * [Funciones Send](es/internals_send_functions.md)
+  * [Herramientas Sysex](es/internals_sysex_tools.md)
@@ -47,7 +47,7 @@ SUBSYSTEMS=="usb", ATTRS{idVendor}=="feed", MODE:="0666"
 SUBSYSTEMS=="usb", ATTRS{idVendor}=="1c11", MODE:="0666"
 ```

-**/etc/udev/rules.d/55-catalina.rules:**
+**/etc/udev/rules.d/55-caterina.rules:**
 ```
 # ModemManager should ignore the following devices
 ATTRS{idVendor}=="2a03", ENV{ID_MM_DEVICE_IGNORE}="1"
@@ -69,6 +69,12 @@ SUBSYSTEMS=="usb", ATTRS{idVendor}=="1eaf", ATTRS{idProduct}=="0003", MODE:="066
 SUBSYSTEMS=="usb", ATTRS{idVendor}=="0483", ATTRS{idProduct}=="df11", MODE:="0666"
 ```

+**/etc/udev/rules.d/57-bootloadhid.rules:**
+```
+# bootloadHID
+SUBSYSTEMS=="usb", ATTRS{idVendor}=="16c0", ATTRS{idProduct}=="05df", MODE:="0666"
+```
+
 ### Serial device is not detected in bootloader mode on Linux
 Make sure your kernel has appropriate support for your device. If your device uses USB ACM, such as
 Pro Micro (Atmega32u4), make sure to include `CONFIG_USB_ACM=y`. Other devices may require `USB_SERIAL` and any of its sub options.
@@ -22,10 +22,10 @@ void matrix_scan_user(void) {
      SEND_STRING("QMK is awesome.");
    }
    SEQ_TWO_KEYS(KC_D, KC_D) {
-      SEND_STRING(SS_LCTRL("a")SS_LCTRL("c"));
+      SEND_STRING(SS_LCTL("a") SS_LCTL("c"));
    }
    SEQ_THREE_KEYS(KC_D, KC_D, KC_S) {
-      SEND_STRING("https://start.duckduckgo.com"SS_TAP(X_ENTER));
+      SEND_STRING("https://start.duckduckgo.com\n");
    }
    SEQ_TWO_KEYS(KC_A, KC_S) {
      register_code(KC_LGUI);
@@ -115,11 +115,11 @@ void matrix_scan_user(void) {

    SEQ_ONE_KEY(KC_E) {
      // Anything you can do in a macro.
-      SEND_STRING(SS_LCTRL(SS_LSFT("t")));
+      SEND_STRING(SS_LCTL(SS_LSFT("t")));
      did_leader_succeed = true;
    } else 
    SEQ_TWO_KEYS(KC_E, KC_D) {
-      SEND_STRING(SS_LGUI("r")"cmd"SS_TAP(KC_ENTER)SS_LCTRL("c"));
+      SEND_STRING(SS_LGUI("r") "cmd\n" SS_LCTL("c"));
      did_leader_succeed = true;
    }
    leader_end();
@@ -67,14 +67,14 @@ bool process_record_user(uint16_t keycode, keyrecord_t *record) {
    case QMKURL:
      if (record->event.pressed) {
        // when keycode QMKURL is pressed
-        SEND_STRING("https://qmk.fm/" SS_TAP(X_ENTER));
+        SEND_STRING("https://qmk.fm/\n");
      } else {
        // when keycode QMKURL is released
      }
      break;
    case MY_OTHER_MACRO:
      if (record->event.pressed) {
-                SEND_STRING(SS_LCTRL("ac")); // selects all and copies
+                SEND_STRING(SS_LCTL("ac")); // selects all and copies
      }
      break;
  }
@@ -109,18 +109,21 @@ Which would send "VE" followed by a `KC_HOME` tap, and "LO" (spelling "LOVE" if

 There's also a couple of mod shortcuts you can use:

-* `SS_LCTRL(string)`
-* `SS_LGUI(string)`
-* `SS_LALT(string)`
+* `SS_LCTL(string)`
 * `SS_LSFT(string)`
-* `SS_RALT(string)`
+* `SS_LALT(string)`
+* `SS_LGUI(string)`, `SS_LCMD(string)` or `SS_LWIN(string)`
+* `SS_RCTL(string)`
+* `SS_RSFT(string)`
+* `SS_RALT(string)` or `SS_ALGR(string)`
+* `SS_RGUI(string)`, `SS_RCMD(string)` or `SS_RWIN(string)`

 These press the respective modifier, send the supplied string and then release the modifier.
 They can be used like this:

-    SEND_STRING(SS_LCTRL("a"));
+    SEND_STRING(SS_LCTL("a"));

-Which would send LCTRL+a (LCTRL down, a, LCTRL up) - notice that they take strings (eg `"k"`), and not the `X_K` keycodes.
+Which would send Left Control+`a` (Left Control down, `a`, Left Control up) - notice that they take strings (eg `"k"`), and not the `X_K` keycodes.

 ### Alternative Keymaps

@@ -173,16 +173,20 @@ As mentioned earlier, the center of the keyboard by default is expected to be `{

 All RGB keycodes are currently shared with the RGBLIGHT system:

-* `RGB_TOG` - toggle
-* `RGB_MOD` - cycle through modes
-* `RGB_HUI` - increase hue
-* `RGB_HUD` - decrease hue
-* `RGB_SAI` - increase saturation
-* `RGB_SAD` - decrease saturation
-* `RGB_VAI` - increase value
-* `RGB_VAD` - decrease value
-* `RGB_SPI` - increase speed effect (no EEPROM support)
-* `RGB_SPD` - decrease speed effect (no EEPROM support)
+|Key                |Aliases   |Description                                                                           |
+|-------------------|----------|--------------------------------------------------------------------------------------|
+|`RGB_TOG`          |          |Toggle RGB lighting on or off                                                         |
+|`RGB_MODE_FORWARD` |`RGB_MOD` |Cycle through modes, reverse direction when Shift is held                             |
+|`RGB_MODE_REVERSE` |`RGB_RMOD`|Cycle through modes in reverse, forward direction when Shift is held                  |
+|`RGB_HUI`          |          |Increase hue, decrease hue when Shift is held                                         |
+|`RGB_HUD`          |          |Decrease hue, increase hue when Shift is held                                         |
+|`RGB_SAI`          |          |Increase saturation, decrease saturation when Shift is held                           |
+|`RGB_SAD`          |          |Decrease saturation, increase saturation when Shift is held                           |
+|`RGB_VAI`          |          |Increase value (brightness), decrease value when Shift is held                        |
+|`RGB_VAD`          |          |Decrease value (brightness), increase value when Shift is held                        |
+|`RGB_SPI`          |          |Increase effect speed (does not support eeprom yet), decrease speed when Shift is held|
+|`RGB_SPD`          |          |Decrease effect speed (does not support eeprom yet), increase speed when Shift is held|
+
 * `RGB_MODE_*` keycodes will generally work, but are not currently mapped to the correct effects for the RGB Matrix system

 ## RGB Matrix Effects
@@ -48,12 +48,12 @@ Changing the **Value** sets the overall brightness.<br>
 |`RGB_TOG`          |          |Toggle RGB lighting on or off                                       |
 |`RGB_MODE_FORWARD` |`RGB_MOD` |Cycle through modes, reverse direction when Shift is held           |
 |`RGB_MODE_REVERSE` |`RGB_RMOD`|Cycle through modes in reverse, forward direction when Shift is held|
-|`RGB_HUI`          |          |Increase hue                                                        |
-|`RGB_HUD`          |          |Decrease hue                                                        |
-|`RGB_SAI`          |          |Increase saturation                                                 |
-|`RGB_SAD`          |          |Decrease saturation                                                 |
-|`RGB_VAI`          |          |Increase value (brightness)                                         |
-|`RGB_VAD`          |          |Decrease value (brightness)                                         |
+|`RGB_HUI`          |          |Increase hue, decrease hue when Shift is held                       |
+|`RGB_HUD`          |          |Decrease hue, increase hue when Shift is held                       |
+|`RGB_SAI`          |          |Increase saturation, decrease saturation when Shift is held         |
+|`RGB_SAD`          |          |Decrease saturation, increase saturation when Shift is held         |
+|`RGB_VAI`          |          |Increase value (brightness), decrease value when Shift is held      |
+|`RGB_VAD`          |          |Decrease value (brightness), increase value when Shift is held      |
 |`RGB_MODE_PLAIN`   |`RGB_M_P `|Static (no animation) mode                                          |
 |`RGB_MODE_BREATHE` |`RGB_M_B` |Breathing animation mode                                            |
 |`RGB_MODE_RAINBOW` |`RGB_M_R` |Rainbow animation mode                                              |
@@ -208,15 +208,15 @@ bool process_record_user(uint16_t keycode, keyrecord_t *record) {
            clear_mods(); clear_oneshot_mods();
            SEND_STRING("make " QMK_KEYBOARD ":" QMK_KEYMAP);
    #ifndef FLASH_BOOTLOADER
-            if ( (temp_mod | temp_osm) & MOD_MASK_SHIFT ) 
+            if ((temp_mod | temp_osm) & MOD_MASK_SHIFT)
    #endif
-            { // 
+            {
                SEND_STRING(":flash");
            }
-            if ( (temp_mod | temp_osm) & MOD_MASK_CTRL) { 
-                SEND_STRING(" -j8 --output-sync"); 
+            if ((temp_mod | temp_osm) & MOD_MASK_CTRL) {
+                SEND_STRING(" -j8 --output-sync");
            }
-            SEND_STRING(SS_TAP(X_ENTER));
+            tap_code(KC_ENT);
            set_mods(temp_mod);
        }
        break;
@@ -13,7 +13,7 @@ General flashing sequence:

 ## bootloadHID Flashing Target

-Using the QMK installation script, detailed [here](newbs_getting_started.md), the required bootloadHID tools should be automatically installed.
+?> Using the QMK installation script, detailed [here](newbs_getting_started.md), the required bootloadHID tools should be automatically installed.

 To flash via the command line, use the target `:bootloadHID` by executing the following command:

@@ -19,7 +19,7 @@ Sinon, vous pouvez aussi le télécharger directement en ([zip](https://github.c

 ## Comment le compiler

-Avant d'être prêt à compiler vous allez devoir [installer un environnement](getting_started_build_tools.md) pour les développements AVR et/ou ARM. Une fois ceci fait, vous pourrez utiliser la commande `make` pour compiler le clavier et la disposition avec une commande de ce type :
+Avant d'être prêt à compiler vous allez devoir [installer un environnement](fr-fr/getting_started_build_tools.md) pour les développements AVR et/ou ARM. Une fois ceci fait, vous pourrez utiliser la commande `make` pour compiler le clavier et la disposition avec une commande de ce type :

    make planck/rev4:default

@@ -29,4 +29,4 @@ Cette commande compilera la révision `rev4` du clavier `planck` avec la disposi

 ## Comment le personnaliser

-QMK a beaucoup de [fonctionnalités](features.md) à explorer, et [une documentation](http://docs.qmk.fm) très abondante que vous pourrez parcourir. La plupart des fonctionnalités vous permettrons de modifier vos [dispositions](keymap.md) (keymaps) et de changer [les codes de caractères](keycodes.md) (keycodes).
+QMK a beaucoup de [fonctionnalités](fr-fr/features.md) à explorer, et [une documentation](http://docs.qmk.fm) très abondante que vous pourrez parcourir. La plupart des fonctionnalités vous permettrons de modifier vos [dispositions](fr-fr/keymap.md) (keymaps) et de changer [les codes de caractères](fr-fr/keycodes.md) (keycodes).
@@ -29,97 +29,97 @@
 **En Anglais**

 * Guides détaillés
-  * [Installation des outils de compilation](getting_started_build_tools.md)
-  * [Guide Vagrant](getting_started_vagrant.md)
-  * [Commandes de compilations](getting_started_make_guide.md)
+  * [Installation des outils de compilation](fr-fr/getting_started_build_tools.md)
+  * [Guide Vagrant](fr-fr/getting_started_vagrant.md)
+  * [Commandes de compilations](fr-fr/getting_started_make_guide.md)
  * [Flasher les firmwares](fr-fr/flashing.md)
-  * [Personnaliser les fonctionnalités](custom_quantum_functions.md)
-  * [Aperçu des fonctionnalités des dispositions](keymap.md)
+  * [Personnaliser les fonctionnalités](fr-fr/custom_quantum_functions.md)
+  * [Aperçu des fonctionnalités des dispositions](fr-fr/keymap.md)

-* [Hardware](hardware.md)
-  * [Processeurs AVR](hardware_avr.md)
-  * [Pilotes / Drivers](hardware_drivers.md)
+* [Hardware](fr-fr/hardware.md)
+  * [Processeurs AVR](fr-fr/hardware_avr.md)
+  * [Pilotes / Drivers](fr-fr/hardware_drivers.md)

 * Réferences
-  * [Lignes de conduite des claviers](hardware_keyboard_guidelines.md)
-  * [Options de configurations](config_options.md)
-  * [Keycodes / Codes des caractères](keycodes.md)
-  * [Conventions de codage - C](coding_conventions_c.md)
-  * [Conventions de codage - Python](coding_conventions_python.md)
-  * [Meilleurs pratiques sur la documentation](documentation_best_practices.md)
-  * [Modèles de documentation](documentation_templates.md)
-  * [Glossaire](reference_glossary.md)
-  * [Tests unitaires](unit_testing.md)
-  * [Fonctions utiles](ref_functions.md)
-  * [Support de configuration](reference_configurator_support.md)
-  * [Format du fichier info.json](reference_info_json.md)
-  * [Développer la CLI en Python](cli_development.md)
+  * [Lignes de conduite des claviers](fr-fr/hardware_keyboard_guidelines.md)
+  * [Options de configurations](fr-fr/config_options.md)
+  * [Keycodes / Codes des caractères](fr-fr/keycodes.md)
+  * [Conventions de codage - C](fr-fr/coding_conventions_c.md)
+  * [Conventions de codage - Python](fr-fr/coding_conventions_python.md)
+  * [Meilleurs pratiques sur la documentation](fr-fr/documentation_best_practices.md)
+  * [Modèles de documentation](fr-fr/documentation_templates.md)
+  * [Glossaire](fr-fr/reference_glossary.md)
+  * [Tests unitaires](fr-fr/unit_testing.md)
+  * [Fonctions utiles](fr-fr/ref_functions.md)
+  * [Support de configuration](fr-fr/reference_configurator_support.md)
+  * [Format du fichier info.json](fr-fr/reference_info_json.md)
+  * [Développer la CLI en Python](fr-fr/cli_development.md)

-* [Fonctionnalités](features.md)
-  * [Keycodes basiques](keycodes_basic.md)
-  * [Touches utilisées avec Shift (US ANSI)](keycodes_us_ansi_shifted.md)
-  * [Keycodes quantiques](quantum_keycodes.md)
-  * [Keycodes avancés](feature_advanced_keycodes.md)
-  * [Fonctionnalités audio](feature_audio.md)
-  * [Majuscule automatique](feature_auto_shift.md)
-  * [Rétroéclairage](feature_backlight.md)
-  * [Bluetooth](feature_bluetooth.md)
-  * [Bootmagic](feature_bootmagic.md)
-  * [Combos](feature_combo.md)
-  * [Commande](feature_command.md)
-  * [API anti-rebond](feature_debounce_type.md)
-  * [DIP Switch](feature_dip_switch.md)
-  * [Macros dynamiques](feature_dynamic_macros.md)
-  * [Interrupteurs rotatifs](feature_encoders.md)
-  * [Grave Escape](feature_grave_esc.md)
-  * [Retour haptique](feature_haptic_feedback.md)
-  * [Contrôleur LCD HD44780](feature_hd44780.md)
-  * [Touche à verrou / Lock-key](feature_key_lock.md)
-  * [Dispositions / layouts](feature_layouts.md)
-  * [Touche leader](feature_leader_key.md)
-  * [Matrice LED](feature_led_matrix.md)
-  * [Macros](feature_macros.md)
-  * [Boutons de souris](feature_mouse_keys.md)
-  * [Pilotes / Drivers OLED](feature_oled_driver.md)
-  * [Touche one-shot](feature_advanced_keycodes.md#one-shot-keys)
-  * [Périphériques de pointage](feature_pointing_device.md)
-  * [Souris PS/2](feature_ps2_mouse.md)
-  * [Éclairage RGB](feature_rgblight.md)
-  * [Matrice RGB](feature_rgb_matrix.md)
-  * [Space Cadet](feature_space_cadet.md)
-  * [Claviers scindés / splittés](feature_split_keyboard.md)
-  * [Stenographie](feature_stenography.md)
-  * [Inversion des mains](feature_swap_hands.md)
-  * [Tap Dance](feature_tap_dance.md)
-  * [Terminale](feature_terminal.md)
-  * [Imprimante thermique](feature_thermal_printer.md)
-  * [Caractères unicodes](feature_unicode.md)
-  * [Dossier utilisateur](feature_userspace.md)
-  * [Velocikey](feature_velocikey.md)
+* [Fonctionnalités](fr-fr/features.md)
+  * [Keycodes basiques](fr-fr/keycodes_basic.md)
+  * [Touches utilisées avec Shift (US ANSI)](fr-fr/keycodes_us_ansi_shifted.md)
+  * [Keycodes quantiques](fr-fr/quantum_keycodes.md)
+  * [Keycodes avancés](fr-fr/feature_advanced_keycodes.md)
+  * [Fonctionnalités audio](fr-fr/feature_audio.md)
+  * [Majuscule automatique](fr-fr/feature_auto_shift.md)
+  * [Rétroéclairage](fr-fr/feature_backlight.md)
+  * [Bluetooth](fr-fr/feature_bluetooth.md)
+  * [Bootmagic](fr-fr/feature_bootmagic.md)
+  * [Combos](fr-fr/feature_combo.md)
+  * [Commande](fr-fr/feature_command.md)
+  * [API anti-rebond](fr-fr/feature_debounce_type.md)
+  * [DIP Switch](fr-fr/feature_dip_switch.md)
+  * [Macros dynamiques](fr-fr/feature_dynamic_macros.md)
+  * [Interrupteurs rotatifs](fr-fr/feature_encoders.md)
+  * [Grave Escape](fr-fr/feature_grave_esc.md)
+  * [Retour haptique](fr-fr/feature_haptic_feedback.md)
+  * [Contrôleur LCD HD44780](fr-fr/feature_hd44780.md)
+  * [Touche à verrou / Lock-key](fr-fr/feature_key_lock.md)
+  * [Dispositions / layouts](fr-fr/feature_layouts.md)
+  * [Touche leader](fr-fr/feature_leader_key.md)
+  * [Matrice LED](fr-fr/feature_led_matrix.md)
+  * [Macros](fr-fr/feature_macros.md)
+  * [Boutons de souris](fr-fr/feature_mouse_keys.md)
+  * [Pilotes / Drivers OLED](fr-fr/feature_oled_driver.md)
+  * [Touche one-shot](fr-fr/feature_advanced_keycodes.md#one-shot-keys)
+  * [Périphériques de pointage](fr-fr/feature_pointing_device.md)
+  * [Souris PS/2](fr-fr/feature_ps2_mouse.md)
+  * [Éclairage RGB](fr-fr/feature_rgblight.md)
+  * [Matrice RGB](fr-fr/feature_rgb_matrix.md)
+  * [Space Cadet](fr-fr/feature_space_cadet.md)
+  * [Claviers scindés / splittés](fr-fr/feature_split_keyboard.md)
+  * [Stenographie](fr-fr/feature_stenography.md)
+  * [Inversion des mains](fr-fr/feature_swap_hands.md)
+  * [Tap Dance](fr-fr/feature_tap_dance.md)
+  * [Terminale](fr-fr/feature_terminal.md)
+  * [Imprimante thermique](fr-fr/feature_thermal_printer.md)
+  * [Caractères unicodes](fr-fr/feature_unicode.md)
+  * [Dossier utilisateur](fr-fr/feature_userspace.md)
+  * [Velocikey](fr-fr/feature_velocikey.md)

 * Pour les makers et les bricoleurs
-  * [Guide des claviers soudés à la main](hand_wire.md)
-  * [Guide de flash de l’ISP](isp_flashing_guide.md)
-  * [Guide du débogage ARM](arm_debugging.md)
-  * [Drivers i2c](i2c_driver.md)
-  * [Contrôles des GPIO](internals_gpio_control.md)
-  * [Conversion en Proton C](proton_c_conversion.md)
+  * [Guide des claviers soudés à la main](fr-fr/hand_wire.md)
+  * [Guide de flash de l’ISP](fr-fr/isp_flashing_guide.md)
+  * [Guide du débogage ARM](fr-fr/arm_debugging.md)
+  * [Drivers i2c](fr-fr/i2c_driver.md)
+  * [Contrôles des GPIO](fr-fr/internals_gpio_control.md)
+  * [Conversion en Proton C](fr-fr/proton_c_conversion.md)

 * Pour aller plus loin
-  * [Comment fonctionnent les claviers](how_keyboards_work.md)
-  * [Comprendre QMK](understanding_qmk.md)
+  * [Comment fonctionnent les claviers](fr-fr/how_keyboards_work.md)
+  * [Comprendre QMK](fr-fr/understanding_qmk.md)

 * Autres sujets
-  * [Utiliser Eclipse avec QMK](other_eclipse.md)
-  * [Utiliser VSCode avec QMK](other_vscode.md)
-  * [Support](support.md)
-  * [Comment ajouter des traductions](translating.md)
+  * [Utiliser Eclipse avec QMK](fr-fr/other_eclipse.md)
+  * [Utiliser VSCode avec QMK](fr-fr/other_vscode.md)
+  * [Support](fr-fr/support.md)
+  * [Comment ajouter des traductions](fr-fr/translating.md)

 * À l’intérieur de QMK (En cours de documentation)
-  * [Définitions](internals_defines.md)
-  * [Input Callback Reg](internals_input_callback_reg.md)
-  * [Appareils Midi](internals_midi_device.md)
-  * [Installation d’un appareil Midi](internals_midi_device_setup_process.md)
-  * [Utilitaires Midi](internals_midi_util.md)
-  * [Fonctions Midi](internals_send_functions.md)
-  * [Outils Sysex](internals_sysex_tools.md)
+  * [Définitions](fr-fr/internals_defines.md)
+  * [Input Callback Reg](fr-fr/internals_input_callback_reg.md)
+  * [Appareils Midi](fr-fr/internals_midi_device.md)
+  * [Installation d’un appareil Midi](fr-fr/internals_midi_device_setup_process.md)
+  * [Utilitaires Midi](fr-fr/internals_midi_util.md)
+  * [Fonctions Midi](fr-fr/internals_send_functions.md)
+  * [Outils Sysex](fr-fr/internals_sysex_tools.md)
@@ -20,7 +20,7 @@ QMK (*Quantum Mechanical Keyboard*) היא קהילת קוד פתוח (open sour

 ## איך לקמפל

-לפני שתצליחו לקמפל, תדרשו [להתקין סביבה](getting_started_build_tools.md) עבור פיתוח AVR ו/או ARM. ברגע שהדבר בוצע, תוכלו להריץ פקודת `make` כדי לבנות מקלדת ומיפוי עם התחביר הבא: 
+לפני שתצליחו לקמפל, תדרשו [להתקין סביבה](he-il/getting_started_build_tools.md) עבור פיתוח AVR ו/או ARM. ברגע שהדבר בוצע, תוכלו להריץ פקודת `make` כדי לבנות מקלדת ומיפוי עם התחביר הבא: 

    make planck/rev4:default

@@ -30,5 +30,5 @@ QMK (*Quantum Mechanical Keyboard*) היא קהילת קוד פתוח (open sour

 ## איך להתאים

-לQMK יש המון [יכולות](features.md) שאפשר לנווט בהן, וכמות נכבדת של [תיעוד ודוקומנטציה](http://docs.qmk.fm) בה אפשר לנבור. רוב הפיצ׳רים באים לידי ביטוי על ידי שינוי  [מיפוי המקלדת](keymap.md) ושינוי  [קודי המקשים](keycodes.md).
+לQMK יש המון [יכולות](he-il/features.md) שאפשר לנווט בהן, וכמות נכבדת של [תיעוד ודוקומנטציה](http://docs.qmk.fm) בה אפשר לנבור. רוב הפיצ׳רים באים לידי ביטוי על ידי שינוי  [מיפוי המקלדת](he-il/keymap.md) ושינוי  [קודי המקשים](he-il/keycodes.md).
 </div>
@@ -1,6 +1,7 @@
 <div dir="rtl" markdown="1">
+
 **בשפה העברית**
-* [המדריך המלא למתחילים](newbs.md)
+* [המדריך המלא למתחילים](he-il/newbs.md)
  * [מקורות ללמידה](he-il/newbs_learn_more_resources.md)
 * [בסיס QMK](he-il/README.md)
    * [מבוא לQMK](he-il/getting_started_introduction.md)
@@ -13,126 +14,126 @@
  * [איך לתעד נכון](he-il/documentation_best_practices.md)

 **בשפה האנגלית**
-* [המדריך המלא למתחילים](newbs.md)
-  * [התחלה](newbs_getting_started.md)
-  * [בנייה של הקושחה הראשונה שלך](newbs_building_firmware.md)
-  * [צריבה של הקושחה](newbs_flashing.md)
-  * [בדיקות ודיבאגינג](newbs_testing_debugging.md)
-  * [עבודה נכונה ב GIT](newbs_best_practices.md)
-  * [מקורות ללמידה](newbs_learn_more_resources.md)
+* [המדריך המלא למתחילים](he-il/newbs.md)
+  * [התחלה](he-il/newbs_getting_started.md)
+  * [בנייה של הקושחה הראשונה שלך](he-il/newbs_building_firmware.md)
+  * [צריבה של הקושחה](he-il/newbs_flashing.md)
+  * [בדיקות ודיבאגינג](he-il/newbs_testing_debugging.md)
+  * [עבודה נכונה ב GIT](he-il/newbs_best_practices.md)
+  * [מקורות ללמידה](he-il/newbs_learn_more_resources.md)

-* [בסיס QMK](README.md)
-  * [מבוא לQMK](getting_started_introduction.md)
-  * [QMK CLI](cli.md)
-  * [QMK CLI Config](cli_configuration.md)
-  * [תרומה ל QMK](contributing.md)
-  * [איך להשתמש בGithub](getting_started_github.md)
-  * [קבלת עזרה](getting_started_getting_help.md)
+* [בסיס QMK](he-il/README.md)
+  * [מבוא לQMK](he-il/getting_started_introduction.md)
+  * [QMK CLI](he-il/cli.md)
+  * [QMK CLI Config](he-il/cli_configuration.md)
+  * [תרומה ל QMK](he-il/contributing.md)
+  * [איך להשתמש בGithub](he-il/getting_started_github.md)
+  * [קבלת עזרה](he-il/getting_started_getting_help.md)

-* [שינויים משמעותיים](breaking_changes.md)
-  * [2019 Aug 30](ChangeLog/20190830.md)
+* [שינויים משמעותיים](he-il/breaking_changes.md)
+  * [2019 Aug 30](he-il/ChangeLog/20190830.md)

-* [שאלות נפוצות](faq.md)
-  * [שאלות נפוצות כלליות](faq_general.md)
-  * [בנייה/קומפילציה של QMK](faq_build.md)
-  * [דיבאגינג ופתרון תקלות של QMK](faq_debug.md)
-  * [מיפוי מקשים](faq_keymap.md)
-  * [התקנת דרייברים עם Zadig](driver_installation_zadig.md)
+* [שאלות נפוצות](he-il/faq.md)
+  * [שאלות נפוצות כלליות](he-il/faq_general.md)
+  * [בנייה/קומפילציה של QMK](he-il/faq_build.md)
+  * [דיבאגינג ופתרון תקלות של QMK](he-il/faq_debug.md)
+  * [מיפוי מקשים](he-il/faq_keymap.md)
+  * [התקנת דרייברים עם Zadig](he-il/driver_installation_zadig.md)

 * מדריכים מפורטים
-  * [התקנת כלי Build](getting_started_build_tools.md)
-  * [מדריך Vagrant](getting_started_vagrant.md)
-  * [הוראות בנייה/קומפילציה](getting_started_make_guide.md)
-  * [צריבת קושחה](flashing.md)
-  * [התאמה אישית של הפונקציונאליות](custom_quantum_functions.md)
-  * [מיפוי מקשים](keymap.md)
+  * [התקנת כלי Build](he-il/getting_started_build_tools.md)
+  * [מדריך Vagrant](he-il/getting_started_vagrant.md)
+  * [הוראות בנייה/קומפילציה](he-il/getting_started_make_guide.md)
+  * [צריבת קושחה](he-il/flashing.md)
+  * [התאמה אישית של הפונקציונאליות](he-il/custom_quantum_functions.md)
+  * [מיפוי מקשים](he-il/keymap.md)

-* [חומרה](hardware.md)
-  * [מעבדי AVR](hardware_avr.md)
-  * [דרייברים](hardware_drivers.md)
+* [חומרה](he-il/hardware.md)
+  * [מעבדי AVR](he-il/hardware_avr.md)
+  * [דרייברים](he-il/hardware_drivers.md)

 * התייחסויות
-  * [מדריך למקלדות](hardware_keyboard_guidelines.md)
-  * [אפשרויות הגדרות](config_options.md)
-  * [קודי מקשים](keycodes.md)
-  * [קונבנציות קוד - C](coding_conventions_c.md)
-  * [קונבנציות קוד - Python](coding_conventions_python.md)
-  * [איך לתעד נכון](documentation_best_practices.md)
-  * [טמפלטים לדוקומנטציה](documentation_templates.md)
-  * [מילון](reference_glossary.md)
-  * [בדיקות יחידה](unit_testing.md)
-  * [פונקציות שימושיות](ref_functions.md)
-  * [תמיכה בConfigurator](reference_configurator_support.md)
-  * [פורמט info.json](reference_info_json.md)
-  * [פיתוח בPython CLI](cli_development.md)
+  * [מדריך למקלדות](he-il/hardware_keyboard_guidelines.md)
+  * [אפשרויות הגדרות](he-il/config_options.md)
+  * [קודי מקשים](he-il/keycodes.md)
+  * [קונבנציות קוד - C](he-il/coding_conventions_c.md)
+  * [קונבנציות קוד - Python](he-il/coding_conventions_python.md)
+  * [איך לתעד נכון](he-il/documentation_best_practices.md)
+  * [טמפלטים לדוקומנטציה](he-il/documentation_templates.md)
+  * [מילון](he-il/reference_glossary.md)
+  * [בדיקות יחידה](he-il/unit_testing.md)
+  * [פונקציות שימושיות](he-il/ref_functions.md)
+  * [תמיכה בConfigurator](he-il/reference_configurator_support.md)
+  * [פורמט info.json](he-il/reference_info_json.md)
+  * [פיתוח בPython CLI](he-il/cli_development.md)

-* [תכונות](features.md)
-  * [Basic Keycodes](keycodes_basic.md)
-  * [US ANSI Shifted Keys](keycodes_us_ansi_shifted.md)
-  * [Quantum Keycodes](quantum_keycodes.md)
-  * [Advanced Keycodes](feature_advanced_keycodes.md)
-  * [Audio](feature_audio.md)
-  * [Auto Shift](feature_auto_shift.md)
-  * [Backlight](feature_backlight.md)
-  * [Bluetooth](feature_bluetooth.md)
-  * [Bootmagic](feature_bootmagic.md)
-  * [Combos](feature_combo.md)
-  * [Command](feature_command.md)
-  * [Debounce API](feature_debounce_type.md)
-  * [DIP Switch](feature_dip_switch.md)
-  * [Dynamic Macros](feature_dynamic_macros.md)
-  * [Encoders](feature_encoders.md)
-  * [Grave Escape](feature_grave_esc.md)
-  * [Haptic Feedback](feature_haptic_feedback.md)
-  * [HD44780 LCD Controller](feature_hd44780.md)
-  * [Key Lock](feature_key_lock.md)
-  * [Layouts](feature_layouts.md)
-  * [Leader Key](feature_leader_key.md)
-  * [LED Matrix](feature_led_matrix.md)
-  * [Macros](feature_macros.md)
-  * [Mouse Keys](feature_mouse_keys.md)
-  * [OLED Driver](feature_oled_driver.md)
-  * [One Shot Keys](feature_advanced_keycodes.md#one-shot-keys)
-  * [Pointing Device](feature_pointing_device.md)
-  * [PS/2 Mouse](feature_ps2_mouse.md)
-  * [RGB Lighting](feature_rgblight.md)
-  * [RGB Matrix](feature_rgb_matrix.md)
-  * [Space Cadet](feature_space_cadet.md)
-  * [Split Keyboard](feature_split_keyboard.md)
-  * [Stenography](feature_stenography.md)
-  * [Swap Hands](feature_swap_hands.md)
-  * [Tap Dance](feature_tap_dance.md)
-  * [Terminal](feature_terminal.md)
-  * [Thermal Printer](feature_thermal_printer.md)
-  * [Unicode](feature_unicode.md)
-  * [Userspace](feature_userspace.md)
-  * [Velocikey](feature_velocikey.md)
+* [תכונות](he-il/features.md)
+  * [Basic Keycodes](he-il/keycodes_basic.md)
+  * [US ANSI Shifted Keys](he-il/keycodes_us_ansi_shifted.md)
+  * [Quantum Keycodes](he-il/quantum_keycodes.md)
+  * [Advanced Keycodes](he-il/feature_advanced_keycodes.md)
+  * [Audio](he-il/feature_audio.md)
+  * [Auto Shift](he-il/feature_auto_shift.md)
+  * [Backlight](he-il/feature_backlight.md)
+  * [Bluetooth](he-il/feature_bluetooth.md)
+  * [Bootmagic](he-il/feature_bootmagic.md)
+  * [Combos](he-il/feature_combo.md)
+  * [Command](he-il/feature_command.md)
+  * [Debounce API](he-il/feature_debounce_type.md)
+  * [DIP Switch](he-il/feature_dip_switch.md)
+  * [Dynamic Macros](he-il/feature_dynamic_macros.md)
+  * [Encoders](he-il/feature_encoders.md)
+  * [Grave Escape](he-il/feature_grave_esc.md)
+  * [Haptic Feedback](he-il/feature_haptic_feedback.md)
+  * [HD44780 LCD Controller](he-il/feature_hd44780.md)
+  * [Key Lock](he-il/feature_key_lock.md)
+  * [Layouts](he-il/feature_layouts.md)
+  * [Leader Key](he-il/feature_leader_key.md)
+  * [LED Matrix](he-il/feature_led_matrix.md)
+  * [Macros](he-il/feature_macros.md)
+  * [Mouse Keys](he-il/feature_mouse_keys.md)
+  * [OLED Driver](he-il/feature_oled_driver.md)
+  * [One Shot Keys](he-il/feature_advanced_keycodes.md#one-shot-keys)
+  * [Pointing Device](he-il/feature_pointing_device.md)
+  * [PS/2 Mouse](he-il/feature_ps2_mouse.md)
+  * [RGB Lighting](he-il/feature_rgblight.md)
+  * [RGB Matrix](he-il/feature_rgb_matrix.md)
+  * [Space Cadet](he-il/feature_space_cadet.md)
+  * [Split Keyboard](he-il/feature_split_keyboard.md)
+  * [Stenography](he-il/feature_stenography.md)
+  * [Swap Hands](he-il/feature_swap_hands.md)
+  * [Tap Dance](he-il/feature_tap_dance.md)
+  * [Terminal](he-il/feature_terminal.md)
+  * [Thermal Printer](he-il/feature_thermal_printer.md)
+  * [Unicode](he-il/feature_unicode.md)
+  * [Userspace](he-il/feature_userspace.md)
+  * [Velocikey](he-il/feature_velocikey.md)

 * למייקרים ומודרים
-  * [מדריך לכתיבה ידנית](hand_wire.md)
-  * [מדריך לצריבת ISP](isp_flashing_guide.md)
-  * [מדריך לדיבאגינג ARM](arm_debugging.md)
-  * [מנהל התקן I2C](i2c_driver.md)
-  * [בקרת GPIO](internals_gpio_control.md)
-  * [המרת Proton C](proton_c_conversion.md)
+  * [מדריך לכתיבה ידנית](he-il/hand_wire.md)
+  * [מדריך לצריבת ISP](he-il/isp_flashing_guide.md)
+  * [מדריך לדיבאגינג ARM](he-il/arm_debugging.md)
+  * [מנהל התקן I2C](he-il/i2c_driver.md)
+  * [בקרת GPIO](he-il/internals_gpio_control.md)
+  * [המרת Proton C](he-il/proton_c_conversion.md)

 * להבנה עמוקה יותר
-  * [איך עובדות מקלדות](how_keyboards_work.md)
-  * [להבין את QMK](understanding_qmk.md)
+  * [איך עובדות מקלדות](he-il/how_keyboards_work.md)
+  * [להבין את QMK](he-il/understanding_qmk.md)

 * נושאים נוספים
-  * [שימוש ב - Eclipse עם QMK](other_eclipse.md)
-  * [שימוש ב - VSCode עם QMK](other_vscode.md)
-  * [תמיכה](support.md)
-  * [כיצד להוסיף תרגום](translating.md)
+  * [שימוש ב - Eclipse עם QMK](he-il/other_eclipse.md)
+  * [שימוש ב - VSCode עם QMK](he-il/other_vscode.md)
+  * [תמיכה](he-il/support.md)
+  * [כיצד להוסיף תרגום](he-il/translating.md)

 * QMK מבפנים (בתהליך)
-  * [Defines](internals_defines.md)
-  * [Input Callback Reg](internals_input_callback_reg.md)
-  * [Midi Device](internals_midi_device.md)
-  * [Midi Device Setup Process](internals_midi_device_setup_process.md)
-  * [Midi Util](internals_midi_util.md)
-  * [Send Functions](internals_send_functions.md)
-  * [Sysex Tools](internals_sysex_tools.md)
+  * [Defines](he-il/internals_defines.md)
+  * [Input Callback Reg](he-il/internals_input_callback_reg.md)
+  * [Midi Device](he-il/internals_midi_device.md)
+  * [Midi Device Setup Process](he-il/internals_midi_device_setup_process.md)
+  * [Midi Util](he-il/internals_midi_util.md)
+  * [Send Functions](he-il/internals_send_functions.md)
+  * [Sysex Tools](he-il/internals_sysex_tools.md)

 </div>
@@ -21,7 +21,7 @@
  <div id="app"></div>
  <script>
    window.$docsify = {
-      alias : {
+      alias: {
        '/en/(.*)': '/$1',
        '/en-us/(.*)': '/$1',
        '/en-gb/(.*)': '/$1',
@@ -29,12 +29,30 @@
      },
      basePath: '/',
      name: 'QMK Firmware',
-      nameLink: '/',
+      nameLink: {
+        '/de/': '/#/de/',
+        '/es/': '/#/es/',
+        '/fr-fr/': '/#/fr-fr/',
+        '/he-il/': '/#/he-il/',
+        '/ja/': '/#/ja/',
+        '/ru-ru/': '/#/ru-ru/',
+        '/zh-cn/': '/#/zh-cn/',
+        '/': '/#/'
+      },
      repo: 'qmk/qmk_firmware',
      loadSidebar: '_summary.md',
      loadNavbar: '_langs.md',
      mergeNavbar: true,
      auto2top: true,
+      fallbackLanguages: [
+        'de',
+        'es',
+        'fr-fr',
+        'he-il',
+        'ja',
+        'ru-ru',
+        'zh-cn'
+      ],
      formatUpdated: '{YYYY}/{MM}/{DD} {HH}:{mm}',
      search: {
        paths: 'auto',
@@ -389,12 +389,12 @@ This is a reference only. Each group of keys links to the page documenting their
 |`RGB_TOG`          |          |Toggle RGB lighting on or off                                       |
 |`RGB_MODE_FORWARD` |`RGB_MOD` |Cycle through modes, reverse direction when Shift is held           |
 |`RGB_MODE_REVERSE` |`RGB_RMOD`|Cycle through modes in reverse, forward direction when Shift is held|
-|`RGB_HUI`          |          |Increase hue                                                        |
-|`RGB_HUD`          |          |Decrease hue                                                        |
-|`RGB_SAI`          |          |Increase saturation                                                 |
-|`RGB_SAD`          |          |Decrease saturation                                                 |
-|`RGB_VAI`          |          |Increase value (brightness)                                         |
-|`RGB_VAD`          |          |Decrease value (brightness)                                         |
+|`RGB_HUI`          |          |Increase hue, decrease hue when Shift is held                       |
+|`RGB_HUD`          |          |Decrease hue, increase hue when Shift is held                       |
+|`RGB_SAI`          |          |Increase saturation, decrease saturation when Shift is held         |
+|`RGB_SAD`          |          |Decrease saturation, increase saturation when Shift is held         |
+|`RGB_VAI`          |          |Increase value (brightness), decrease value when Shift is held      |
+|`RGB_VAD`          |          |Decrease value (brightness), increase value when Shift is held      |
 |`RGB_MODE_PLAIN`   |`RGB_M_P `|Static (no animation) mode                                          |
 |`RGB_MODE_BREATHE` |`RGB_M_B` |Breathing animation mode                                            |
 |`RGB_MODE_RAINBOW` |`RGB_M_R` |Rainbow animation mode                                              |
@@ -407,19 +407,19 @@ This is a reference only. Each group of keys links to the page documenting their

 ## [RGB Matrix Lighting](feature_rgb_matrix.md)

-|Key                |Aliases   |Description                                                         |
-|-------------------|----------|--------------------------------------------------------------------|
-|`RGB_TOG`          |          |Toggle RGB lighting on or off                                       |
-|`RGB_MODE_FORWARD` |`RGB_MOD` |Cycle through modes, reverse direction when Shift is held           |
-|`RGB_MODE_REVERSE` |`RGB_RMOD`|Cycle through modes in reverse, forward direction when Shift is held|
-|`RGB_HUI`          |          |Increase hue                                                        |
-|`RGB_HUD`          |          |Decrease hue                                                        |
-|`RGB_SAI`          |          |Increase saturation                                                 |
-|`RGB_SAD`          |          |Decrease saturation                                                 |
-|`RGB_VAI`          |          |Increase value (brightness)                                         |
-|`RGB_VAD`          |          |Decrease value (brightness)                                         |
-|`RGB_SPI`          |          |Increase effect speed (does no support eeprom yet)                  |
-|`RGB_SPD`          |          |Decrease effect speed (does no support eeprom yet)                  |
+|Key                |Aliases   |Description                                                                           |
+|-------------------|----------|--------------------------------------------------------------------------------------|
+|`RGB_TOG`          |          |Toggle RGB lighting on or off                                                         |
+|`RGB_MODE_FORWARD` |`RGB_MOD` |Cycle through modes, reverse direction when Shift is held                             |
+|`RGB_MODE_REVERSE` |`RGB_RMOD`|Cycle through modes in reverse, forward direction when Shift is held                  |
+|`RGB_HUI`          |          |Increase hue, decrease hue when Shift is held                                         |
+|`RGB_HUD`          |          |Decrease hue, increase hue when Shift is held                                         |
+|`RGB_SAI`          |          |Increase saturation, decrease saturation when Shift is held                           |
+|`RGB_SAD`          |          |Decrease saturation, increase saturation when Shift is held                           |
+|`RGB_VAI`          |          |Increase value (brightness), decrease value when Shift is held                        |
+|`RGB_VAD`          |          |Decrease value (brightness), increase value when Shift is held                        |
+|`RGB_SPI`          |          |Increase effect speed (does not support eeprom yet), decrease speed when Shift is held|
+|`RGB_SPD`          |          |Decrease effect speed (does not support eeprom yet), increase speed when Shift is held|

 ## [Thermal Printer](feature_thermal_printer.md)

@@ -0,0 +1,123 @@
+* [Complete Newbs Guide](ru-ru/newbs.md)
+  * [Getting Started](ru-ru/newbs_getting_started.md)
+  * [Building Your First Firmware](ru-ru/newbs_building_firmware.md)
+  * [Flashing Firmware](ru-ru/newbs_flashing.md)
+  * [Testing and Debugging](ru-ru/newbs_testing_debugging.md)
+  * [Git Best Practices](ru-ru/newbs_best_practices.md)
+  * [Learning Resources](ru-ru/newbs_learn_more_resources.md)
+
+* [QMK Basics](ru-ru/README.md)
+  * [QMK Introduction](ru-ru/getting_started_introduction.md)
+  * [QMK CLI](ru-ru/cli.md)
+  * [QMK CLI Config](ru-ru/cli_configuration.md)
+  * [Contributing to QMK](ru-ru/contributing.md)
+  * [How to Use Github](ru-ru/getting_started_github.md)
+  * [Getting Help](ru-ru/getting_started_getting_help.md)
+
+* [Breaking Changes](ru-ru/breaking_changes.md)
+  * [2019 Aug 30](ru-ru/ChangeLog/20190830.md)
+
+* [FAQ](ru-ru/faq.md)
+  * [General FAQ](ru-ru/faq_general.md)
+  * [Build/Compile QMK](ru-ru/faq_build.md)
+  * [Debugging/Troubleshooting QMK](ru-ru/faq_debug.md)
+  * [Keymap](ru-ru/faq_keymap.md)
+  * [Driver Installation with Zadig](ru-ru/driver_installation_zadig.md)
+
+* Detailed Guides
+  * [Install Build Tools](ru-ru/getting_started_build_tools.md)
+  * [Vagrant Guide](ru-ru/getting_started_vagrant.md)
+  * [Build/Compile Instructions](ru-ru/getting_started_make_guide.md)
+  * [Flashing Firmware](ru-ru/flashing.md)
+  * [Customizing Functionality](ru-ru/custom_quantum_functions.md)
+  * [Keymap Overview](ru-ru/keymap.md)
+
+* [Hardware](ru-ru/hardware.md)
+  * [Compatible Microcontrollers](ru-ru/compatible_microcontrollers.md)
+  * [AVR Processors](ru-ru/hardware_avr.md)
+  * [Drivers](ru-ru/hardware_drivers.md)
+
+* Reference
+  * [Keyboard Guidelines](ru-ru/hardware_keyboard_guidelines.md)
+  * [Config Options](ru-ru/config_options.md)
+  * [Keycodes](ru-ru/keycodes.md)
+  * [Coding Conventions - C](ru-ru/coding_conventions_c.md)
+  * [Coding Conventions - Python](ru-ru/coding_conventions_python.md)
+  * [Documentation Best Practices](ru-ru/documentation_best_practices.md)
+  * [Documentation Templates](ru-ru/documentation_templates.md)
+  * [Glossary](ru-ru/reference_glossary.md)
+  * [Unit Testing](ru-ru/unit_testing.md)
+  * [Useful Functions](ru-ru/ref_functions.md)
+  * [Configurator Support](ru-ru/reference_configurator_support.md)
+  * [info.json Format](ru-ru/reference_info_json.md)
+  * [Python CLI Development](ru-ru/cli_development.md)
+
+* [Features](ru-ru/features.md)
+  * [Basic Keycodes](ru-ru/keycodes_basic.md)
+  * [US ANSI Shifted Keys](ru-ru/keycodes_us_ansi_shifted.md)
+  * [Quantum Keycodes](ru-ru/quantum_keycodes.md)
+  * [Advanced Keycodes](ru-ru/feature_advanced_keycodes.md)
+  * [Audio](ru-ru/feature_audio.md)
+  * [Auto Shift](ru-ru/feature_auto_shift.md)
+  * [Backlight](ru-ru/feature_backlight.md)
+  * [Bluetooth](ru-ru/feature_bluetooth.md)
+  * [Bootmagic](ru-ru/feature_bootmagic.md)
+  * [Combos](ru-ru/feature_combo.md)
+  * [Command](ru-ru/feature_command.md)
+  * [Debounce API](ru-ru/feature_debounce_type.md)
+  * [DIP Switch](ru-ru/feature_dip_switch.md)
+  * [Dynamic Macros](ru-ru/feature_dynamic_macros.md)
+  * [Encoders](ru-ru/feature_encoders.md)
+  * [Grave Escape](ru-ru/feature_grave_esc.md)
+  * [Haptic Feedback](ru-ru/feature_haptic_feedback.md)
+  * [HD44780 LCD Controller](ru-ru/feature_hd44780.md)
+  * [Key Lock](ru-ru/feature_key_lock.md)
+  * [Layouts](ru-ru/feature_layouts.md)
+  * [Leader Key](ru-ru/feature_leader_key.md)
+  * [LED Matrix](ru-ru/feature_led_matrix.md)
+  * [Macros](ru-ru/feature_macros.md)
+  * [Mouse Keys](ru-ru/feature_mouse_keys.md)
+  * [OLED Driver](ru-ru/feature_oled_driver.md)
+  * [One Shot Keys](ru-ru/feature_advanced_keycodes.md#one-shot-keys)
+  * [Pointing Device](ru-ru/feature_pointing_device.md)
+  * [PS/2 Mouse](ru-ru/feature_ps2_mouse.md)
+  * [RGB Lighting](ru-ru/feature_rgblight.md)
+  * [RGB Matrix](ru-ru/feature_rgb_matrix.md)
+  * [Space Cadet](ru-ru/feature_space_cadet.md)
+  * [Split Keyboard](ru-ru/feature_split_keyboard.md)
+  * [Stenography](ru-ru/feature_stenography.md)
+  * [Swap Hands](ru-ru/feature_swap_hands.md)
+  * [Tap Dance](ru-ru/feature_tap_dance.md)
+  * [Terminal](ru-ru/feature_terminal.md)
+  * [Thermal Printer](ru-ru/feature_thermal_printer.md)
+  * [Unicode](ru-ru/feature_unicode.md)
+  * [Userspace](ru-ru/feature_userspace.md)
+  * [Velocikey](ru-ru/feature_velocikey.md)
+
+* For Makers and Modders
+  * [Hand Wiring Guide](ru-ru/hand_wire.md)
+  * [ISP Flashing Guide](ru-ru/isp_flashing_guide.md)
+  * [ARM Debugging Guide](ru-ru/arm_debugging.md)
+  * [I2C Driver](ru-ru/i2c_driver.md)
+  * [WS2812 Driver](ru-ru/ws2812_driver.md)
+  * [GPIO Controls](ru-ru/internals_gpio_control.md)
+  * [Proton C Conversion](ru-ru/proton_c_conversion.md)
+
+* For a Deeper Understanding
+  * [How Keyboards Work](ru-ru/how_keyboards_work.md)
+  * [Understanding QMK](ru-ru/understanding_qmk.md)
+
+* Other Topics
+  * [Using Eclipse with QMK](ru-ru/other_eclipse.md)
+  * [Using VSCode with QMK](ru-ru/other_vscode.md)
+  * [Support](ru-ru/support.md)
+  * [Translating the QMK Docs](ru-ru/translating.md)
+
+* QMK Internals (In Progress)
+  * [Defines](ru-ru/internals_defines.md)
+  * [Input Callback Reg](ru-ru/internals_input_callback_reg.md)
+  * [Midi Device](ru-ru/internals_midi_device.md)
+  * [Midi Device Setup Process](ru-ru/internals_midi_device_setup_process.md)
+  * [Midi Util](ru-ru/internals_midi_util.md)
+  * [Send Functions](ru-ru/internals_send_functions.md)
+  * [Sysex Tools](ru-ru/internals_sysex_tools.md)
@@ -1,29 +1,55 @@
-# How to translate the QMK docs into different languages
+# Translating the QMK Docs

 All files in the root folder (`docs/`) should be in English - all other languages should be in subfolders with the ISO 639-1 language codes, followed by `-` and the country code where relevant. [A list of common ones can be found here](https://www.andiamo.co.uk/resources/iso-language-codes/). If this folder doesn't exist, you may create it. Each of the translated files should have the same name as the English version, so things can fall back successfully.

 A `_summary.md` file should exist in this folder with a list of links to each file, with a translated name, and link preceded by the language folder:

-    * [QMK简介](zh-cn/getting_started_introduction.md)
+```markdown
+ * [QMK简介](zh-cn/getting_started_introduction.md)
+```
+
+All links to other docs pages must also be prefixed with the language folder. If the link is to a specific part of the page (ie. a certain heading), you must use the English ID for the heading, like so:
+
+```markdown
+[建立你的环境](zh-cn/newbs-getting-started.md#set-up-your-environment)
+
+## 建立你的环境 :id=set-up-your-environment
+```

 Once you've finished translating a new language, you'll also need to modify the following files:

 * [`docs/_langs.md`](https://github.com/qmk/qmk_firmware/blob/master/docs/_langs.md)  
-  Each line should contain a country flag in the format `:us:` followed by the name represented in its own language:  
-  
-      - [:cn: 中文](/zh-cn/)
+  Each line should contain a country flag as a [GitHub emoji shortcode](https://github.com/ikatyang/emoji-cheat-sheet/blob/master/README.md#country-flag) followed by the name represented in its own language:
+
+  ```markdown
+   - [:cn: 中文](/zh-cn/)
+  ```

 * [`docs/index.html`](https://github.com/qmk/qmk_firmware/blob/master/docs/index.html)  
-  Both `placeholder` and `noData` objects should have a dictionary entry for the language folder in a string:  
-  
-      '/zh-cn/': '没有结果!',
+  Both `placeholder` and `noData` objects should have a dictionary entry for the language folder in a string:

-## Previewing the translations
+  ```js
+  '/zh-cn/': '没有结果!',
+  ```

-Before opening a pull request, you can preview your additions if you have Python 3 installed by running this command in the `docs/` folder:
+  The `nameLink` object, for setting the "QMK Firmware" heading link in the sidebar, must also be added to:

-    python -m http.server 9000
+  ```js
+  '/zh-cn/': '/#/zh-cn/',
+  ```

-and navigating to http://localhost:9000/ - you should be able to select your new language from the "Translations" menu at the top-right.
+  And make sure to add the language folder in the `fallbackLanguages` list, so it will properly fall back to English instead of 404ing:
+
+  ```js
+  fallbackLanguages: [
+    // ...
+    'zh-cn',
+    // ...
+  ],
+  ```
+
+## Previewing the Translations
+
+See [Previewing the Documentation](contributing.md#previewing-the-documentation) for how to set up a local instance of the docs - you should be able to select your new language from the "Translations" menu at the top-right.

 Once you're happy with your work, feel free to open a pull request!
@@ -19,7 +19,7 @@ QMK (*Quantum Mechanical Keyboard*) 是一个社区维护的开源软件，包

 ## 如何编译

-在你能编译之前, 你需要[部署环境](getting_started_build_tools.md) 用于 AVR or/and ARM 开发。完成后, 你可以使用 `make` 命令来编译一个键盘和布局使用以下命令:
+在你能编译之前, 你需要[部署环境](zh-cn/getting_started_build_tools.md) 用于 AVR or/and ARM 开发。完成后, 你可以使用 `make` 命令来编译一个键盘和布局使用以下命令:

    make planck/rev4:default

@@ -29,4 +29,4 @@ QMK (*Quantum Mechanical Keyboard*) 是一个社区维护的开源软件，包

 ## 如何定制

-QMK 有许多 [特性](features.md)来探索，也有很多 [参考文档](http://docs.qmk.fm) 供您发掘。你可以通过修改 [布局](keymap.md)和[键码](keycodes.md)来利用许多特性。
+QMK 有许多 [特性](zh-cn/features.md)来探索，也有很多 [参考文档](http://docs.qmk.fm) 供您发掘。你可以通过修改 [布局](zh-cn/keymap.md)和[键码](zh-cn/keycodes.md)来利用许多特性。
@@ -24,10 +24,10 @@
 #    include "wait.h"
 #endif

-#include "is31fl3733.h"
 #include <string.h>
 #include "i2c_master.h"
 #include "progmem.h"
+#include "is31fl3733.h"

 // This is a 7-bit address, that gets left-shifted and bit 0
 // set to 0 for write, 1 for read (as per I2C protocol)
@@ -80,43 +80,54 @@ bool    g_pwm_buffer_update_required[DRIVER_COUNT] = {false};
 uint8_t g_led_control_registers[DRIVER_COUNT][24]             = {{0}, {0}};
 bool    g_led_control_registers_update_required[DRIVER_COUNT] = {false};

-void IS31FL3733_write_register(uint8_t addr, uint8_t reg, uint8_t data) {
+bool IS31FL3733_write_register(uint8_t addr, uint8_t reg, uint8_t data) {
+    // If the transaction fails function returns false.
    g_twi_transfer_buffer[0] = reg;
    g_twi_transfer_buffer[1] = data;

 #if ISSI_PERSISTENCE > 0
    for (uint8_t i = 0; i < ISSI_PERSISTENCE; i++) {
-        if (i2c_transmit(addr << 1, g_twi_transfer_buffer, 2, ISSI_TIMEOUT) == 0) break;
+        if (i2c_transmit(addr << 1, g_twi_transfer_buffer, 2, ISSI_TIMEOUT) != 0) {
+            return false;
+        }
    }
 #else
-    i2c_transmit(addr << 1, g_twi_transfer_buffer, 2, ISSI_TIMEOUT);
+    if (i2c_transmit(addr << 1, g_twi_transfer_buffer, 2, ISSI_TIMEOUT) != 0) {
+        return false;
+    }
 #endif
+    return true;
 }

-void IS31FL3733_write_pwm_buffer(uint8_t addr, uint8_t *pwm_buffer) {
-    // assumes PG1 is already selected
-
-    // transmit PWM registers in 12 transfers of 16 bytes
+bool IS31FL3733_write_pwm_buffer(uint8_t addr, uint8_t *pwm_buffer) {
+    // Assumes PG1 is already selected.
+    // If any of the transactions fails function returns false.
+    // Transmit PWM registers in 12 transfers of 16 bytes.
    // g_twi_transfer_buffer[] is 20 bytes

-    // iterate over the pwm_buffer contents at 16 byte intervals
+    // Iterate over the pwm_buffer contents at 16 byte intervals.
    for (int i = 0; i < 192; i += 16) {
        g_twi_transfer_buffer[0] = i;
-        // copy the data from i to i+15
-        // device will auto-increment register for data after the first byte
-        // thus this sets registers 0x00-0x0F, 0x10-0x1F, etc. in one transfer
+        // Copy the data from i to i+15.
+        // Device will auto-increment register for data after the first byte
+        // Thus this sets registers 0x00-0x0F, 0x10-0x1F, etc. in one transfer.
        for (int j = 0; j < 16; j++) {
            g_twi_transfer_buffer[1 + j] = pwm_buffer[i + j];
        }

 #if ISSI_PERSISTENCE > 0
        for (uint8_t i = 0; i < ISSI_PERSISTENCE; i++) {
-            if (i2c_transmit(addr << 1, g_twi_transfer_buffer, 17, ISSI_TIMEOUT) == 0) break;
+            if (i2c_transmit(addr << 1, g_twi_transfer_buffer, 17, ISSI_TIMEOUT) != 0) {
+                return false;
+            }
        }
 #else
-        i2c_transmit(addr << 1, g_twi_transfer_buffer, 17, ISSI_TIMEOUT);
+        if (i2c_transmit(addr << 1, g_twi_transfer_buffer, 17, ISSI_TIMEOUT) != 0) {
+            return false;
+        }
 #endif
    }
+    return true;
 }

 void IS31FL3733_init(uint8_t addr, uint8_t sync) {
@@ -213,11 +224,15 @@ void IS31FL3733_set_led_control_register(uint8_t index, bool red, bool green, bo

 void IS31FL3733_update_pwm_buffers(uint8_t addr, uint8_t index) {
    if (g_pwm_buffer_update_required[index]) {
-        // Firstly we need to unlock the command register and select PG1
+        // Firstly we need to unlock the command register and select PG1.
        IS31FL3733_write_register(addr, ISSI_COMMANDREGISTER_WRITELOCK, 0xC5);
        IS31FL3733_write_register(addr, ISSI_COMMANDREGISTER, ISSI_PAGE_PWM);

-        IS31FL3733_write_pwm_buffer(addr, g_pwm_buffer[index]);
+        // If any of the transactions fail we risk writing dirty PG0,
+        // refresh page 0 just in case.
+        if (!IS31FL3733_write_pwm_buffer(addr, g_pwm_buffer[index])){
+            g_led_control_registers_update_required[index] = true;
+        }
    }
    g_pwm_buffer_update_required[index] = false;
 }
@@ -231,6 +246,5 @@ void IS31FL3733_update_led_control_registers(uint8_t addr, uint8_t index) {
            IS31FL3733_write_register(addr, i, g_led_control_registers[index][i]);
        }
    }
-    // This seems counter intuitive but sometimes this page can get corrupted. So update it every time.
-    // g_led_control_registers_update_required[index] = false;
+    g_led_control_registers_update_required[index] = false;
 }
@@ -32,8 +32,8 @@ typedef struct is31_led {
 extern const is31_led g_is31_leds[DRIVER_LED_TOTAL];

 void IS31FL3733_init(uint8_t addr, uint8_t sync);
-void IS31FL3733_write_register(uint8_t addr, uint8_t reg, uint8_t data);
-void IS31FL3733_write_pwm_buffer(uint8_t addr, uint8_t *pwm_buffer);
+bool IS31FL3733_write_register(uint8_t addr, uint8_t reg, uint8_t data);
+bool IS31FL3733_write_pwm_buffer(uint8_t addr, uint8_t *pwm_buffer);

 void IS31FL3733_set_color(int index, uint8_t red, uint8_t green, uint8_t blue);
 void IS31FL3733_set_color_all(uint8_t red, uint8_t green, uint8_t blue);
@@ -133,7 +133,7 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {

 };

-uint32_t layer_state_set_user(uint32_t state) {
+layer_state_t layer_state_set_user(layer_state_t state) {
  return update_tri_layer_state(state, _LOWER, _RAISE, _ADJUST);
 }

@@ -0,0 +1 @@
+#include "7skb.h"
@@ -0,0 +1,7 @@
+#pragma once
+
+#include "quantum.h"
+
+#ifdef KEYBOARD_7skb_rev1
+  #include "rev1.h"
+#endif
@@ -0,0 +1,21 @@
+/*
+Copyright 2012 Jun Wako <wakojun@gmail.com>
+Copyright 2015 Jack Humbert
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+#pragma once
+
+#include "config_common.h"
@@ -0,0 +1,76 @@
+{
+    "keyboard_name": "7skb", 
+    "url": "https://salicylic-acid3.hatenablog.com/", 
+    "maintainer": "Salicylic_acid3", 
+    "width": 16, 
+    "height": 5, 
+    "layouts": {
+        "LAYOUT": {
+            "layout": [
+                 {"label":"Esc", "x":0, "y":0},
+                 {"label":"1", "x":1, "y":0},
+                 {"label":"2", "x":2, "y":0},
+                 {"label":"3", "x":3, "y":0},
+                 {"label":"4", "x":4, "y":0},
+                 {"label":"5", "x":5, "y":0},
+                 {"label":"6", "x":7, "y":0},
+                 {"label":"7", "x":8, "y":0},
+                 {"label":"8", "x":9, "y":0},
+                 {"label":"9", "x":10, "y":0},
+                 {"label":"0", "x":11, "y":0},
+                 {"label":"-", "x":12, "y":0},
+                 {"label":"=", "x":13, "y":0},
+                 {"label":"\\", "x":14, "y":0},
+                 {"label":"`", "x":15, "y":0},
+                 {"label":"Tab", "x":0, "y":1, "w":1.5},
+                 {"label":"Q", "x":1.5, "y":1},
+                 {"label":"W", "x":2.5, "y":1},
+                 {"label":"E", "x":3.5, "y":1},
+                 {"label":"R", "x":4.5, "y":1},
+                 {"label":"T", "x":5.5, "y":1},
+                 {"label":"Y", "x":7.5, "y":1},
+                 {"label":"U", "x":8.5, "y":1},
+                 {"label":"I", "x":9.5, "y":1},
+                 {"label":"O", "x":10.5, "y":1},
+                 {"label":"P", "x":11.5, "y":1},
+                 {"label":"[", "x":12.5, "y":1},
+                 {"label":"]", "x":13.5, "y":1},
+                 {"label":"Delete", "x":14.5, "y":1, "w":1.5},
+                 {"label":"Control", "x":0, "y":2, "w":1.75},
+                 {"label":"A", "x":1.75, "y":2},
+                 {"label":"S", "x":2.75, "y":2},
+                 {"label":"D", "x":3.75, "y":2},
+                 {"label":"F", "x":4.75, "y":2},
+                 {"label":"G", "x":5.75, "y":2},
+                 {"label":"H", "x":7.75, "y":2},
+                 {"label":"J", "x":8.75, "y":2},
+                 {"label":"K", "x":9.75, "y":2},
+                 {"label":"L", "x":10.75, "y":2},
+                 {"label":";", "x":11.75, "y":2},
+                 {"label":"'", "x":12.75, "y":2},
+                 {"label":"Enter", "x":13.75, "y":2, "w":2.25},
+                 {"label":"Shift", "x":0, "y":3, "w":2.25},
+                 {"label":"Z", "x":2.25, "y":3},
+                 {"label":"X", "x":3.25, "y":3},
+                 {"label":"C", "x":4.25, "y":3},
+                 {"label":"V", "x":5.25, "y":3},
+                 {"label":"B", "x":6.25, "y":3},
+                 {"label":"N", "x":8.25, "y":3},
+                 {"label":"M", "x":9.25, "y":3},
+                 {"label":",", "x":10.25, "y":3},
+                 {"label":".", "x":11.25, "y":3},
+                 {"label":"/", "x":12.25, "y":3},
+                 {"label":"Shift", "x":13.25, "y":3, "w":1.75},
+                 {"label":"Fn", "x":15, "y":3},
+                 {"label":"Alt", "x":1.5, "y":4},
+                 {"label":"GUI", "x":2.5, "y":4, "w":1.5},
+                 {"x":4, "y":4, "w":1.5},
+                 {"x":5.5, "y":4, "w":1.25},
+                 {"x":7.75, "y":4, "w":1.25},
+                 {"x":9, "y":4, "w":2},
+                 {"label":"GUI", "x":11, "y":4, "w":1.5},
+                 {"label":"Alt", "x":12.5, "y":4}
+            ]
+        }
+    }
+}
@@ -0,0 +1,22 @@
+/* Copyright 2018 Salicylic_acid3
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#pragma once
+
+/* Select hand configuration */
+
+#define TAPPING_FORCE_HOLD
+#define TAPPING_TERM 180
@@ -0,0 +1,115 @@
+#include QMK_KEYBOARD_H
+
+
+#ifdef RGBLIGHT_ENABLE
+//Following line allows macro to read current RGB settings
+extern rgblight_config_t rgblight_config;
+#endif
+
+extern uint8_t is_master;
+
+// Each layer gets a name for readability, which is then used in the keymap matrix below.
+// The underscores don't mean anything - you can have a layer called STUFF or any other name.
+// Layer names don't all need to be of the same length, obviously, and you can also skip them
+// entirely and just use numbers.
+enum layer_number {
+  _QWERTY = 0,
+  _FN,
+  _ADJUST,
+};
+
+enum custom_keycodes {
+  RGB_RST = SAFE_RANGE
+};
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+  [_QWERTY] = LAYOUT(
+  //,-----------------------------------------------------|   |--------------------------------------------------------------------------------.
+       KC_ESC,    KC_1,    KC_2,    KC_3,    KC_4,    KC_5,        KC_6,    KC_7,    KC_8,    KC_9,    KC_0, KC_MINS,  KC_EQL, KC_BSLS,KC_GRAVE,
+  //|--------+--------+--------+--------+--------+--------|   |--------+--------+--------+--------+--------+--------+--------+--------+--------|
+       KC_TAB,    KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,        KC_Y,    KC_U,    KC_I,    KC_O,    KC_P, KC_LCBR, KC_RCBR,KC_BSPC,
+  //|--------+--------+--------+--------+--------+--------|   |--------+--------+--------+--------+--------+--------+--------+--------|
+     KC_LCTRL,    KC_A,    KC_S,    KC_D,    KC_F,    KC_G,        KC_H,    KC_J,    KC_K,    KC_L, KC_SCLN, KC_QUOT,  KC_ENT,
+  //|--------+--------+--------+--------+--------+--------|   |--------+--------+--------+--------+--------+--------+--------|
+      KC_LSFT,    KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,        KC_N,    KC_M, KC_COMM,  KC_DOT, KC_SLSH, KC_RSFT, MO(_FN),
+  //|--------+--------+--------+--------+--------+--------|   |--------+--------+--------+--------+--------+--------+--------|
+               KC_LALT, KC_LGUI,  KC_SPC,  KC_SPC,               KC_SPC,  KC_SPC,          KC_RGUI, KC_RALT 
+          //`---------------------------------------------|   |--------------------------------------------'
+  ),
+
+  [_FN] = LAYOUT(
+  //,-----------------------------------------------------|   |--------------------------------------------------------------------------------.
+  TG(_ADJUST),   KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,       KC_F6,   KC_F7,   KC_F8,   KC_F9,  KC_F10,  KC_F11,  KC_F12,  KC_INS,  KC_DEL,
+  //|--------+--------+--------+--------+--------+--------|   |--------+--------+--------+--------+--------+--------+--------+--------+--------|
+      _______, _______, _______, _______, _______, _______,     _______, _______, KC_PSCR, KC_SLCK,KC_PAUSE,   KC_UP, _______, KC_BSPC,
+  //|--------+--------+--------+--------+--------+--------|   |--------+--------+--------+--------+--------+--------+--------+--------|
+      _______, _______, _______, _______, _______, _______,     _______, _______, KC_HOME, KC_PGUP, KC_LEFT,KC_RIGHT, _______,
+  //|--------+--------+--------+--------+--------+--------|   |--------+--------+--------+--------+--------+--------+--------|
+      _______, _______, _______, _______, _______, _______,     _______, _______,  KC_END, KC_PGDN, KC_DOWN, _______, _______,
+  //|--------+--------+--------+--------+--------+--------|   |--------+--------+--------+--------+--------+--------+--------|
+               _______, _______, _______, _______,              _______, _______,          KC_STOP, _______ 
+          //`---------------------------------------------|   |--------------------------------------------'
+  ),
+
+  [_ADJUST] = LAYOUT( /* Base */
+  //,-----------------------------------------------------|   |--------------------------------------------------------------------------------.
+  TG(_ADJUST), XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,     XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,   RESET,
+  //|--------+--------+--------+--------+--------+--------|   |--------+--------+--------+--------+--------+--------+--------+--------+--------|
+      XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,     RGB_RST, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,
+  //|--------+--------+--------+--------+--------+--------|   |--------+--------+--------+--------+--------+--------+--------+--------|
+      XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,     RGB_TOG, RGB_MOD, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,
+  //|--------+--------+--------+--------+--------+--------|   |--------+--------+--------+--------+--------+--------+--------|
+      XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,     RGB_VAD, RGB_VAI, RGB_HUD, RGB_HUI, RGB_SAD, RGB_SAI, XXXXXXX,
+  //|--------+--------+--------+--------+--------+--------|   |--------+--------+--------+--------+--------+--------+--------|
+               XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,              XXXXXXX, XXXXXXX,          KC_STOP, XXXXXXX 
+          //`---------------------------------------------|   |--------------------------------------------'
+  )
+};
+
+
+//A description for expressing the layer position in LED mode.
+layer_state_t layer_state_set_user(layer_state_t state) {
+#ifdef RGBLIGHT_ENABLE
+    switch (get_highest_layer(state)) {
+    case _FN:
+      rgblight_sethsv_at(HSV_BLUE, 0);
+      break;
+    case _ADJUST:
+      rgblight_sethsv_at(HSV_PURPLE, 0);
+      break;
+    default: //  for any other layers, or the default layer
+      rgblight_sethsv_at( 0, 0, 0, 0);
+      break;
+    }
+    rgblight_set_effect_range( 1, 4);
+#endif
+return state;
+}
+
+int RGB_current_mode;
+bool process_record_user(uint16_t keycode, keyrecord_t *record) {
+  bool result = false;
+  switch (keycode) {
+    #ifdef RGBLIGHT_ENABLE
+      case RGB_MOD:
+          if (record->event.pressed) {
+            rgblight_mode(RGB_current_mode);
+            rgblight_step();
+            RGB_current_mode = rgblight_config.mode;
+          }
+        break;
+      case RGB_RST:
+          if (record->event.pressed) {
+            eeconfig_update_rgblight_default();
+            rgblight_enable();
+            RGB_current_mode = rgblight_config.mode;
+          }
+        break;
+    #endif
+    default:
+      result = true;
+      break;
+  }
+
+  return result;
+}
@@ -0,0 +1,23 @@
+/* Copyright 2018 Salicylic_acid3
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#pragma once
+
+/* Select hand configuration */
+
+#define TAPPING_FORCE_HOLD
+#define TAPPING_TERM 180
+//#define MASTER_RIGHT
@@ -0,0 +1,181 @@
+#include QMK_KEYBOARD_H
+#include "keymap_jp.h"
+
+
+#ifdef RGBLIGHT_ENABLE
+//Following line allows macro to read current RGB settings
+extern rgblight_config_t rgblight_config;
+#endif
+
+extern uint8_t is_master;
+
+// Each layer gets a name for readability, which is then used in the keymap matrix below.
+// The underscores don't mean anything - you can have a layer called STUFF or any other name.
+// Layer names don't all need to be of the same length, obviously, and you can also skip them
+// entirely and just use numbers.
+enum layer_number {
+  _QWERTY = 0,
+  _FLOCK,
+  _FN,
+  _LOWER,
+  _RAISE,
+  _ADJUST,
+};
+
+enum custom_keycodes {
+  RGB_RST = SAFE_RANGE
+};
+
+enum tapdances{
+  TD_ESFL = 0,
+  TD_ESQW,
+};
+
+qk_tap_dance_action_t tap_dance_actions[] = {
+  [TD_ESFL] = ACTION_TAP_DANCE_DUAL_ROLE(KC_ESC, _FLOCK),
+  [TD_ESQW] = ACTION_TAP_DANCE_DUAL_ROLE(KC_ESC, _QWERTY),
+};
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+  [_QWERTY] = LAYOUT(
+  //,-----------------------------------------------------|   |--------------------------------------------------------------------------------.
+  TD(TD_ESFL),    KC_1,    KC_2,    KC_3,    KC_4,    KC_5,        KC_6,    KC_7,    KC_8,    KC_9,    KC_0, JP_MINS,  JP_EQL, JP_BSLS, KC_ZKHK,
+  //|--------+--------+--------+--------+--------+--------|   |--------+--------+--------+--------+--------+--------+--------+--------+--------|
+       KC_TAB,    KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,        KC_Y,    KC_U,    KC_I,    KC_O,    KC_P, JP_LBRC, JP_RBRC,KC_BSPC,
+  //|--------+--------+--------+--------+--------+--------|   |--------+--------+--------+--------+--------+--------+--------+--------|
+     KC_LCTRL,    KC_A,    KC_S,    KC_D,    KC_F,    KC_G,        KC_H,    KC_J,    KC_K,    KC_L, JP_MINS, JP_BSLS,  KC_ENT,
+  //|--------+--------+--------+--------+--------+--------|   |--------+--------+--------+--------+--------+--------+--------|
+      KC_LSFT,    KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,        KC_N,    KC_M, KC_COMM,  KC_DOT, JP_SLSH, KC_RSFT, MO(_FN),
+  //|--------+--------+--------+--------+--------+--------|   |--------+--------+--------+--------+--------+--------+--------|
+         KC_ZKHK,LGUI_T(KC_MHEN),LT(_LOWER,KC_ENT), KC_BSPC,     KC_DEL, LT(_RAISE,KC_SPC),ALT_T(KC_HENK), KC_APP 
+          //`---------------------------------------------|   |--------------------------------------------'
+  ),
+
+  [_FLOCK] = LAYOUT(
+  //,-----------------------------------------------------|   |--------------------------------------------------------------------------------.
+  TD(TD_ESQW),   KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,       KC_F6,   KC_F7,   KC_F8,   KC_F9,  KC_F10,  KC_F11,  KC_F12, _______, _______,
+  //|--------+--------+--------+--------+--------+--------|   |--------+--------+--------+--------+--------+--------+--------+--------+--------|
+      _______, _______, _______, _______, _______, _______,     _______, _______, _______, _______, _______, _______, _______, _______,
+  //|--------+--------+--------+--------+--------+--------|   |--------+--------+--------+--------+--------+--------+--------+--------|
+      _______, _______, _______, _______, _______, _______,     _______, _______, _______, _______, _______, _______, _______,
+  //|--------+--------+--------+--------+--------+--------|   |--------+--------+--------+--------+--------+--------+--------|
+      _______, _______, _______, _______, _______, _______,     _______, _______, _______, _______, _______, _______, _______,
+  //|--------+--------+--------+--------+--------+--------|   |--------+--------+--------+--------+--------+--------+--------|
+               _______, _______, _______, _______,              _______, _______,          _______, _______ 
+          //`---------------------------------------------|   |--------------------------------------------'
+  ),
+
+  [_FN] = LAYOUT(
+  //,-----------------------------------------------------|   |--------------------------------------------------------------------------------.
+      _______,   KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,       KC_F6,   KC_F7,   KC_F8,   KC_F9,  KC_F10,  KC_F11,  KC_F12, _______,  KC_DEL,
+  //|--------+--------+--------+--------+--------+--------|   |--------+--------+--------+--------+--------+--------+--------+--------+--------|
+      _______, _______, _______, _______, _______, _______,     _______, _______, KC_PSCR, KC_SLCK,KC_PAUSE,   KC_UP, _______, KC_BSPC,
+  //|--------+--------+--------+--------+--------+--------|   |--------+--------+--------+--------+--------+--------+--------+--------|
+      _______, _______, _______, _______, _______, _______,     _______, _______, KC_HOME, KC_PGUP, KC_LEFT,KC_RIGHT, _______,
+  //|--------+--------+--------+--------+--------+--------|   |--------+--------+--------+--------+--------+--------+--------|
+      _______, _______, _______, _______, _______, _______,     _______, _______,  KC_END, KC_PGDN, KC_DOWN, _______, _______,
+  //|--------+--------+--------+--------+--------+--------|   |--------+--------+--------+--------+--------+--------+--------|
+               _______, _______, _______, _______,              _______, _______,          KC_STOP, _______ 
+          //`---------------------------------------------|   |--------------------------------------------'
+  ),
+
+  [_LOWER] = LAYOUT(
+  //,-----------------------------------------------------|   |--------------------------------------------------------------------------------.
+      _______,   KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,       KC_F6,   KC_F7,   KC_F8,   KC_F9,  KC_F10,  KC_F11,  KC_F12,  KC_INS,  KC_DEL,
+  //|--------+--------+--------+--------+--------+--------|   |--------+--------+--------+--------+--------+--------+--------+--------+--------|
+      JP_QUOT, JP_EXLM, JP_QUES, JP_LBRC, JP_RBRC, JP_TILD,       KC_P6,   KC_P7,   KC_P8,   KC_P9, JP_ASTR, JP_SLSH, _______, KC_BSPC,
+  //|--------+--------+--------+--------+--------+--------|   |--------+--------+--------+--------+--------+--------+--------+--------|
+      JP_QUOT, JP_HASH,  JP_DQT, JP_LPRN, JP_RPRN,   JP_AT,     XXXXXXX,   KC_P4,   KC_P5,   KC_P6, JP_MINS,  JP_EQL, _______,
+  //|--------+--------+--------+--------+--------+--------|   |--------+--------+--------+--------+--------+--------+--------|
+      JP_CIRC, JP_PERC, JP_AMPR, JP_SCLN, JP_COLN, JP_PIPE,       KC_P0,   KC_P1,   KC_P2,   KC_P3, JP_PLUS, _______, _______,
+  //|--------+--------+--------+--------+--------+--------|   |--------+--------+--------+--------+--------+--------+--------|
+               _______, _______,MO(_LOWER), _______,            _______, MO(_RAISE),        JP_DOT, _______ 
+          //`---------------------------------------------|   |--------------------------------------------'
+  ),
+
+  [_RAISE] = LAYOUT(
+  //,-----------------------------------------------------|   |--------------------------------------------------------------------------------.
+      _______,   KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,       KC_F6,   KC_F7,   KC_F8,   KC_F9,  KC_F10,  KC_F11,  KC_F12,  KC_INS,  KC_DEL,
+  //|--------+--------+--------+--------+--------+--------|   |--------+--------+--------+--------+--------+--------+--------+--------+--------|
+       KC_TAB,    KC_1,    KC_2,    KC_3,    KC_4,    KC_5,     XXXXXXX, XXXXXXX,   KC_UP, XXXXXXX, KC_PGUP, XXXXXXX, _______, KC_BSPC,
+  //|--------+--------+--------+--------+--------+--------|   |--------+--------+--------+--------+--------+--------+--------+--------|
+LCTL_T(KC_F11),XXXXXXX,   KC_F2,   KC_F3,   KC_F4,   KC_F5,     XXXXXXX, KC_LEFT, KC_DOWN,KC_RIGHT, XXXXXXX, XXXXXXX, _______,
+  //|--------+--------+--------+--------+--------+--------|   |--------+--------+--------+--------+--------+--------+--------|
+SFT_T(KC_F12),   KC_F6,   KC_F7,   KC_F8,   KC_F9,  KC_F10,     XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, KC_PGDN, _______, _______,
+  //|--------+--------+--------+--------+--------+--------|   |--------+--------+--------+--------+--------+--------+--------|
+               _______, _______, _______, _______,              _______, _______,          _______, _______ 
+          //`---------------------------------------------|   |--------------------------------------------'
+  ),
+
+  [_ADJUST] = LAYOUT( /* Base */
+  //,-----------------------------------------------------|   |--------------------------------------------------------------------------------.
+      XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,     XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,   RESET,
+  //|--------+--------+--------+--------+--------+--------|   |--------+--------+--------+--------+--------+--------+--------+--------+--------|
+      XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,     RGB_RST, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,
+  //|--------+--------+--------+--------+--------+--------|   |--------+--------+--------+--------+--------+--------+--------+--------|
+      XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,     RGB_TOG, RGB_MOD, XXXXXXX, LCA(KC_DEL), LALT(KC_PSCR),KC_PSCR, XXXXXXX,
+  //|--------+--------+--------+--------+--------+--------|   |--------+--------+--------+--------+--------+--------+--------|
+      XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,     RGB_VAD, RGB_VAI, RGB_HUD, RGB_HUI, RGB_SAD, RGB_SAI, XXXXXXX,
+  //|--------+--------+--------+--------+--------+--------|   |--------+--------+--------+--------+--------+--------+--------|
+               XXXXXXX, XXXXXXX, _______,   RESET,                RESET, _______,          KC_STOP, XXXXXXX 
+          //`---------------------------------------------|   |--------------------------------------------'
+  )
+};
+
+
+//A description for expressing the layer position in LED mode.
+layer_state_t layer_state_set_user(layer_state_t state) {
+  state = update_tri_layer_state(state, _RAISE, _LOWER, _ADJUST);
+#ifdef RGBLIGHT_ENABLE
+    switch (get_highest_layer(state)) {
+    case _FLOCK:
+      rgblight_sethsv_at(HSV_YELLOW, 0);
+      break;
+    case _FN:
+      rgblight_sethsv_at(HSV_GREEN, 0);
+      break;
+    case _LOWER:
+      rgblight_sethsv_at(HSV_BLUE, 0);
+      break;
+    case _RAISE:
+      rgblight_sethsv_at(HSV_RED, 0);
+      break;
+    case _ADJUST:
+      rgblight_sethsv_at(HSV_PURPLE, 0);
+      break;
+    default: //  for any other layers, or the default layer
+      rgblight_sethsv_at( 0, 0, 0, 0);
+      break;
+    }
+    rgblight_set_effect_range( 1, 4);
+#endif
+return state;
+}
+
+int RGB_current_mode;
+bool process_record_user(uint16_t keycode, keyrecord_t *record) {
+  bool result = false;
+  switch (keycode) {
+    #ifdef RGBLIGHT_ENABLE
+      case RGB_MOD:
+          if (record->event.pressed) {
+            rgblight_mode(RGB_current_mode);
+            rgblight_step();
+            RGB_current_mode = rgblight_config.mode;
+          }
+        break;
+      case RGB_RST:
+          if (record->event.pressed) {
+            eeconfig_update_rgblight_default();
+            rgblight_enable();
+            RGB_current_mode = rgblight_config.mode;
+          }
+        break;
+    #endif
+    default:
+      result = true;
+      break;
+  }
+
+  return result;
+}
@@ -0,0 +1 @@
+TAP_DANCE_ENABLE = yes
@@ -0,0 +1,17 @@
+# 7skb
+
+![7skb](https://cdn-ak.f.st-hatena.com/images/fotolife/S/Salicylic_acid3/20191124/20191124025208.png)
+
+This is 63 keys Custom keyboard.
+
+* Keyboard Maintainer: [Salicylic_acid3](https://github.com/Salicylic-acid3)
+* Hardware Supported: 7skb PCB, Pro Micro
+* Hardware Availability: [PCB & Case Data](https://github.com/Salicylic-acid3/PCB_Data), [Booth Shop](https://salicylic-acid3.booth.pm/items/1673395)
+
+Make example for this keyboard (after setting up your build environment):
+
+    make 7skb:default
+
+See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
+
+[Build guide](https://salicylic-acid3.hatenablog.com/entry/7skb-mx-build-guide)
@@ -0,0 +1,84 @@
+/*
+Copyright 2012 Jun Wako <wakojun@gmail.com>
+Copyright 2015 Jack Humbert
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+#pragma once
+
+#include QMK_KEYBOARD_CONFIG_H
+
+/* USB Device descriptor parameter */
+#define VENDOR_ID       0xFEED
+#define PRODUCT_ID      0x3060
+#define DEVICE_VER      0x0007
+#define MANUFACTURER    Salicylic_Acid
+#define PRODUCT         7skb
+#define DESCRIPTION     A custom keyboard
+
+/* key matrix size */
+#define MATRIX_ROWS 10
+#define MATRIX_COLS 8
+
+// wiring of each half
+#define MATRIX_ROW_PINS { D4, C6, D7, E6, B4 }
+#define MATRIX_COL_PINS { F4, F5, F6, F7, B1, B3, B2, B5 }
+
+/* Set 0 if debouncing isn't needed */
+#define DEBOUNCE 5
+
+/* serial.c configuration for split keyboard */
+#define SOFT_SERIAL_PIN D2
+#define SPLIT_HAND_PIN B6
+
+/* Mechanical locking support. Use KC_LCAP, KC_LNUM or KC_LSCR instead in keymap */
+#define LOCKING_SUPPORT_ENABLE
+/* Locking resynchronize hack */
+#define LOCKING_RESYNC_ENABLE
+
+/* ws2812 RGB LED */
+#define RGB_DI_PIN D3
+
+#ifndef RGBLED_NUM
+  #define RGBLED_NUM 10
+  #define RGBLIGHT_SPLIT
+  #define RGBLED_SPLIT { 5, 5 }
+#endif
+
+#define RGBLIGHT_ANIMATIONS
+
+#ifndef IOS_DEVICE_ENABLE
+  #define RGBLIGHT_LIMIT_VAL 180
+  #define RGBLIGHT_VAL_STEP 17
+#else
+  #define RGBLIGHT_LIMIT_VAL 50
+  #define RGBLIGHT_VAL_STEP 4
+#endif
+#define RGBLIGHT_HUE_STEP 10
+#define RGBLIGHT_SAT_STEP 17
+
+#if defined(RGBLIGHT_ENABLE) && !defined(IOS_DEVICE_ENABLE)
+// USB_MAX_POWER_CONSUMPTION value for naked48 keyboard
+//  120  RGBoff, OLEDoff
+//  120  OLED
+//  330  RGB 6
+//  300  RGB 32
+//  310  OLED & RGB 32
+  #define USB_MAX_POWER_CONSUMPTION 400
+#else
+  // fix iPhone and iPad power adapter issue
+  // iOS device need lessthan 100
+  #define USB_MAX_POWER_CONSUMPTION 100
+#endif
@@ -0,0 +1 @@
+#include "rev1.h"
@@ -0,0 +1,42 @@
+#pragma once
+
+#include "7skb.h"
+
+#include "quantum.h"
+
+//////////////////////////////////////////////////////////////////////////////
+// When only use 7skb.
+//////////////////////////////////////////////////////////////////////////////
+/*
+ * ,------------------------------------   ------------------------------------------------------.
+ * | L00 | L01 | L02 | L03 | L04 | L05 |   | R00 | R01 | R02 | R03 | R04 | R05 | R06 | R07 | R17 |
+ * |---------------------------------------------------------------------------------------------+
+ * |   L10  | L11 | L12 | L13 | L14 | L15 |   | R10 | R11 | R12 | R13 | R14 | R15 | R16 |   R27  |
+ * |----------------------------------------  ---------------------------------------------------+
+ * |   L20   | L21 | L22 | L23 | L24 | L25 |   | R20 | R21 | R22 | R23 | R24 | R25 |     R26     |
+ * |---------------------------------------------------------------------------------------------+
+ * |    L30     | L31 | L32 | L33 | L34 | L35 |   | R30 | R31 | R32 | R33 | R34 |   R35    | R36 |
+ * |-------------------------------------------   -----------------------------------------------'
+ *           | L41 |   L42  | L43  |  L44  |   |  R40  |    R41   |  R43  | R44 |
+ *           |------------------------------   ---------------------------------'
+ */
+
+#define LAYOUT( \
+    L00, L01, L02, L03, L04, L05,      R00, R01, R02, R03, R04, R05, R06, R07, R17, \
+    L10, L11, L12, L13, L14, L15,      R10, R11, R12, R13, R14, R15, R16, R27, \
+    L20, L21, L22, L23, L24, L25,      R20, R21, R22, R23, R24, R25, R26, \
+    L30, L31, L32, L33, L34, L35,      R30, R31, R32, R33, R34, R35, R36, \
+         L41, L42, L43, L44,           R40, R41,      R43, R44 \
+  ) \
+  { \
+    { L00,   L01,   L02,   L03,   L04,   L05,   KC_NO, KC_NO }, \
+    { L10,   L11,   L12,   L13,   L14,   L15,   KC_NO, KC_NO }, \
+    { L20,   L21,   L22,   L23,   L24,   L25,   KC_NO, KC_NO }, \
+    { L30,   L31,   L32,   L33,   L34,   L35,   KC_NO, KC_NO }, \
+    {KC_NO,  L41,   L42,   L43,   L44, KC_NO,   KC_NO, KC_NO }, \
+    { R00,   R01,   R02,   R03,   R04,   R05,   R06,   R07   }, \
+    { R10,   R11,   R12,   R13,   R14,   R15,   R16,   R17   }, \
+    { R20,   R21,   R22,   R23,   R24,   R25,   R26,   R27   }, \
+    { R30,   R31,   R32,   R33,   R34,   R35,   R36,   KC_NO }, \
+    { R40,   R41,   KC_NO, R43,   R44,   KC_NO, KC_NO, KC_NO }  \
+  }
@@ -0,0 +1,35 @@
+# MCU name
+MCU = atmega32u4
+
+# Bootloader selection
+#   Teensy       halfkay
+#   Pro Micro    caterina
+#   Atmel DFU    atmel-dfu
+#   LUFA DFU     lufa-dfu
+#   QMK DFU      qmk-dfu
+#   ATmega32A    bootloadHID
+#   ATmega328P   USBasp
+BOOTLOADER = caterina
+
+# Build Options
+#   change to "no" to disable the options, or define them in the Makefile in
+#   the appropriate keymap folder that will get included automatically
+#
+BOOTMAGIC_ENABLE = no       # Virtual DIP switch configuration
+MOUSEKEY_ENABLE = no        # Mouse keys
+EXTRAKEY_ENABLE = yes       # Audio control and System control
+CONSOLE_ENABLE = no         # Console for debug
+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
+BACKLIGHT_ENABLE = no       # Enable keyboard backlight functionality
+MIDI_ENABLE = no            # MIDI controls
+AUDIO_ENABLE = no           # Audio output on port C6
+UNICODE_ENABLE = no         # Unicode
+BLUETOOTH_ENABLE = no       # Enable Bluetooth with the Adafruit EZ-Key HID
+RGBLIGHT_ENABLE = yes       # Enable WS2812 RGB underlight. 
+# Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE
+SLEEP_LED_ENABLE = no    # Breathing sleep LED during USB suspend
+
+SPLIT_KEYBOARD = yes
+
+DEFAULT_FOLDER = 7skb/rev1
@@ -90,8 +90,8 @@ void led_set_user(uint8_t usb_led) {
    }
 }

-uint32_t layer_state_set_user(uint32_t state) {
-    switch (biton32(state)) {
+layer_state_t layer_state_set_user(layer_state_t state) {
+    switch (get_highest_layer(state)) {
      case 1:
        writePinHigh(D1);
        break;
@@ -85,7 +85,7 @@ void led_set_user(uint8_t usb_led) {

 }

-uint32_t layer_state_set_user(uint32_t state) {
+layer_state_t layer_state_set_user(layer_state_t state) {
 		
 	return state;
 }
@@ -1,42 +1,17 @@
-lSJ Ares
-========
+# lSJ Ares

-Keyboard Maintainer: QMK Community  
-Hardware Supported: LSJ Ares PCB
-Hardware Availability: https://geekhack.org/index.php?topic=93146.0
+* Keyboard Maintainer: QMK Community
+* Hardware Supported: LSJ Ares PCB
+* Hardware Availability: <https://geekhack.org/index.php?topic=93146.0>

 Make example for this keyboard (after setting up your build environment):

    make ares:default

-Flashing
+Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))

-ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods. 
+    make ares:default:flash

-Windows: 
-1. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash).
-2. Place your keyboard into reset by holding the left control key and plugging the cable in. 
-3. Press the `Find Device` button and ensure that your keyboard is found.
-4. Press the `Open .hex File` button and locate the `.hex` file you created.
-5. Press the `Flash Device` button and wait for the process to complete. 
+**Reset Key**: Hold down the *left control* key while plugging in the keyboard.

-macOS:
-1. Install homebrew by typing the following:   
-    ```
-    /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
-    ```
-2. Install `crosspack-avr`.  
-    ```
-    brew cask install crosspack-avr
-    ```
-3. Install the following packages:
-    ```
-    brew install python
-    brew install pyusb
-    brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
-
-4. Place your keyboard into reset. 
-5. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file. 
-
-
-See [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information.
+See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
@@ -1,44 +1,17 @@
-B.fake
-========
+# B.fake

-A 60% keyboard with RGB. The B.fake pcb is a copy of the B.face PCB sold by [winkeyless](https://winkeyless.kr/). However, the switch matrix is actually the same as the [FaceW](https://github.com/qmk/qmk_firmware/tree/master/keyboards/facew), a ps2avr PCB sold on [mechanicalkeyboards.com](https://mechanicalkeyboards.com/). 
+A 60% keyboard with RGB. The B.fake pcb is a copy of the B.face PCB sold by [winkeyless](https://winkeyless.kr/). However, the switch matrix is actually the same as the [FaceW](https://github.com/qmk/qmk_firmware/tree/master/keyboards/facew), a ps2avr PCB sold on [mechanicalkeyboards.com](https://mechanicalkeyboards.com/).

-Keyboard Maintainer: QMK Community  
-Hardware Supported: B.fake PCB  
-Hardware Availability: https://www.aliexpress.com/store/product/bface-60-RGB-underground-copy-pcb-from-china-gh60-pcb-Customize-keyboard-PCB/2230037_32731084597.html
+* Keyboard Maintainer: QMK Community
+* Hardware Supported: B.fake PCB
+* Hardware Availability: <https://www.aliexpress.com/store/product/bface-60-RGB-underground-copy-pcb-from-china-gh60-pcb-Customize-keyboard-PCB/2230037_32731084597.html>

 Make example for this keyboard (after setting up your build environment):

    make bfake:default

-Flashing
+Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))

-ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods. 
+    make bfake:default:flash

-Windows: 
-1. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash).
-2. Place your keyboard into reset. 
-3. Press the `Find Device` button and ensure that your keyboard is found.
-4. Press the `Open .hex File` button and locate the `.hex` file you created.
-5. Press the `Flash Device` button and wait for the process to complete. 
-
-macOS:
-1. Install homebrew by typing the following:   
-    ```
-    /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
-    ```
-2. Install `crosspack-avr`.  
-    ```
-    brew cask install crosspack-avr
-    ```
-3. Install the following packages:
-    ```
-    brew install python
-    brew install pyusb
-    brew install --HEAD`https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
-
-4. Place your keyboard into reset. 
-5. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file. 
-
-
-See [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information.
+See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
@@ -108,7 +108,7 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {

 };

-uint32_t layer_state_set_user(uint32_t state) {
+layer_state_t layer_state_set_user(layer_state_t state) {
  return update_tri_layer_state(state, _LOWER, _RAISE, _ADJUST);
 }

@@ -163,4 +163,3 @@ void matrix_init_user(void) {

 void matrix_scan_user(void) {
 }
-
@@ -19,12 +19,26 @@

 #define LAYOUT( \
    k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, k0c, k0d, k0e, k0f, k0g, \
-    k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1c, k1d, k1e, k1f, k1g, \
-    k20, k22, k23, k24, k25, k26, k27, k28, k29, k2a, k2b, k2c, k2d, k2e, k2f, k2g, \
-    k30, k31, k32, k35, k37, k38, k39, k3a, k3b, k3c, k3d, k3e, k3f, k3g \
+    k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a,      k1c, k1d, k1e, k1f, k1g, \
+    k20,      k22, k23, k24, k25, k26, k27, k28, k29, k2a, k2b, k2c, k2d, k2e, k2f, k2g, \
+    k30, k31, k32,           k35,      k37, k38, k39, k3a, k3b, k3c, k3d, k3e, k3f, k3g \
 ) { \
-    { k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, k0c, k0d, k0e, k0f, k0g }, \
-    { k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, KC_NO, k1c, k1d, k1e, k1f, k1g }, \
-    { k20, KC_NO, k22, k23, k24, k25, k26, k27, k28, k29, k2a, k2b, k2c, k2d, k2e, k2f, k2g }, \
-    { k30, k31, k32, KC_NO, KC_NO, k35, KC_NO, k37, k38, k39, k3a, k3b, k3c, k3d, k3e, k3f, k3g } \
+    { k00, k01  , k02, k03  , k04  , k05, k06  , k07, k08, k09, k0a, k0b  , k0c, k0d, k0e, k0f, k0g }  , \
+    { k10, k11  , k12, k13  , k14  , k15, k16  , k17, k18, k19, k1a, KC_NO, k1c, k1d, k1e, k1f, k1g }  , \
+    { k20, KC_NO, k22, k23  , k24  , k25, k26  , k27, k28, k29, k2a, k2b  , k2c, k2d, k2e, k2f, k2g }  , \
+    { k30, k31  , k32, KC_NO, KC_NO, k35, KC_NO, k37, k38, k39, k3a, k3b  , k3c, k3d, k3e, k3f, k3g } \
 }
+
+#define LAYOUT_lefty( \
+    k0d, k0e, k0f, k0g, k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, k0c, \
+    k1d, k1e, k1f, k1g, k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a,      k1c, \
+    k2d, k2e, k2f, k2g, k20,      k22, k23, k24, k25, k26, k27, k28, k29, k2a, k2b, k2c, \
+    k3d, k3e, k3f, k3g, k30, k31, k32,           k35,      k37, k38, k39, k3a, k3b, k3c \
+) { \
+    { k00, k01  , k02, k03  , k04  , k05, k06  , k07, k08, k09, k0a, k0b  , k0c, k0d, k0e, k0f, k0g }  , \
+    { k10, k11  , k12, k13  , k14  , k15, k16  , k17, k18, k19, k1a, KC_NO, k1c, k1d, k1e, k1f, k1g }  , \
+    { k20, KC_NO, k22, k23  , k24  , k25, k26  , k27, k28, k29, k2a, k2b  , k2c, k2d, k2e, k2f, k2g }  , \
+    { k30, k31  , k32, KC_NO, KC_NO, k35, KC_NO, k37, k38, k39, k3a, k3b  , k3c, k3d, k3e, k3f, k3g } \
+}
+
+#define LAYOUT_righty LAYOUT
@@ -1,210 +1,24 @@
 {
-    "keyboard_name": "TKC Candybar", 
-    "url": "", 
-    "maintainer": "terrymathews", 
-    "width": 17, 
-    "height": 4, 
+    "keyboard_name": "TKC Candybar",
+    "url": "",
+    "maintainer": "terrymathews",
+    "width": 17,
+    "height": 4,
    "layouts": {
        "LAYOUT": {
            "layout": [
-				{"label":"Esc",
-				"x":0,
-				"y":0},
-				{"label":"Q",
-				"x":1,
-				"y":0},
-				{"label":"W",
-				"x":2,
-				"y":0},
-				{"label":"E",
-				"x":3,
-				"y":0},
-				{"label":"R",
-				"x":4,
-				"y":0},
-				{"label":"T",
-				"x":5,
-				"y":0},
-				{"label":"Y",
-				"x":6,
-				"y":0},
-				{"label":"U",
-				"x":7,
-				"y":0},
-				{"label":"I",
-				"x":8,
-				"y":0},
-				{"label":"O",
-				"x":9,
-				"y":0},
-				{"label":"P",
-				"x":10,
-				"y":0},
-				{"label":"Del",
-				"x":11,
-				"y":0},
-				{"label":"BkSp",
-				"x":12,
-				"y":0},
-				{"label":"7",
-				"x":13,
-				"y":0},
-				{"label":"8",
-				"x":14,
-				"y":0},
-				{"label":"9",
-				"x":15,
-				"y":0},
-				{"label":"*",
-				"x":16,
-				"y":0},
-				{"label":"Tab",
-				"x":0,
-				"y":1,
-				"w":1.25},
-				{"label":"A",
-				"x":1.25,
-				"y":1},
-				{"label":"S",
-				"x":2.25,
-				"y":1},
-				{"label":"D",
-				"x":3.25,
-				"y":1},
-				{"label":"F",
-				"x":4.25,
-				"y":1},
-				{"label":"G",
-				"x":5.25,
-				"y":1},
-				{"label":"H",
-				"x":6.25,
-				"y":1},
-				{"label":"J",
-				"x":7.25,
-				"y":1},
-				{"label":"K",
-				"x":8.25,
-				"y":1},
-				{"label":"L",
-				"x":9.25,
-				"y":1},
-				{"label":":",
-				"x":10.25,
-				"y":1},
-				{"label":"Enter",
-				"x":11.25,
-				"y":1,
-				"w":1.75},
-				{"label":"4",
-				"x":13,
-				"y":1},
-				{"label":"5",
-				"x":14,
-				"y":1},
-				{"label":"6",
-				"x":15,
-				"y":1},
-				{"label":"-",
-				"x":16,
-				"y":1},
-				{"label":"Shift",
-				"x":0,
-				"y":2,
-				"w":1.75},
-				{"label":"Z",
-				"x":1.75,
-				"y":2},
-				{"label":"X",
-				"x":2.75,
-				"y":2},
-				{"label":"C",
-				"x":3.75,
-				"y":2},
-				{"label":"V",
-				"x":4.75,
-				"y":2},
-				{"label":"B",
-				"x":5.75,
-				"y":2},
-				{"label":"N",
-				"x":6.75,
-				"y":2},
-				{"label":"M",
-				"x":7.75,
-				"y":2},
-				{"label":"<",
-				"x":8.75,
-				"y":2},
-				{"label":">",
-				"x":9.75,
-				"y":2},
-				{"label":"Shift",
-				"x":10.75,
-				"y":2,
-				"w":1.25},
-				{"label":"&uarr;",
-				"x":12,
-				"y":2},
-				{"label":"1",
-				"x":13,
-				"y":2},
-				{"label":"2",
-				"x":14,
-				"y":2},
-				{"label":"3",
-				"x":15,
-				"y":2},
-				{"label":"+",
-				"x":16,
-				"y":2},
-				{"label":"Ctrl",
-				"x":0,
-				"y":3,
-				"w":1.25},
-				{"label":"GUI",
-				"x":1.25,
-				"y":3,
-				"w":1.25},
-				{"label":"Alt",
-				"x":2.5,
-				"y":3,
-				"w":1.25},
-				{"x":3.75,
-				"y":3,
-				"w":1.75},
-				{"x":5.5,
-				"y":3,
-				"w":1},
-				{"label":"Backspace",
-				"x":6.5,
-				"y":3,
-				"w":2.25},
-				{"label":"Menu",
-				"x":8.75,
-				"y":3,
-				"w":1.25},
-				{"label":"Fn",
-				"x":10,
-				"y":3},
-				{"label":"&larr;",
-				"x":11,
-				"y":3},
-				{"label":"&darr;",
-				"x":12,
-				"y":3},
-				{"label":"&rarr;",
-				"x":13,
-				"y":3},
-				{"label":"0",
-				"x":14,
-				"y":3},
-				{"label":".",
-				"x":15,
-				"y":3},
-				{"label":"Enter",
-				"x":16,
-				"y":3}]
+				{"label":"Esc", "x":0, "y":0}, {"label":"Q", "x":1, "y":0}, {"label":"W", "x":2, "y":0}, {"label":"E", "x":3, "y":0}, {"label":"R", "x":4, "y":0}, {"label":"T", "x":5, "y":0}, {"label":"Y", "x":6, "y":0}, {"label":"U", "x":7, "y":0}, {"label":"I", "x":8, "y":0}, {"label":"O", "x":9, "y":0}, {"label":"P", "x":10, "y":0}, {"label":"Del", "x":11, "y":0}, {"label":"BkSp", "x":12, "y":0}, {"label":"7", "x":13, "y":0}, {"label":"8", "x":14, "y":0}, {"label":"9", "x":15, "y":0}, {"label":"*", "x":16, "y":0},
+				{"label":"Tab", "x":0, "y":1, "w":1.25}, {"label":"A", "x":1.25, "y":1}, {"label":"S", "x":2.25, "y":1}, {"label":"D", "x":3.25, "y":1}, {"label":"F", "x":4.25, "y":1}, {"label":"G", "x":5.25, "y":1}, {"label":"H", "x":6.25, "y":1}, {"label":"J", "x":7.25, "y":1}, {"label":"K", "x":8.25, "y":1}, {"label":"L", "x":9.25, "y":1}, {"label":":", "x":10.25, "y":1}, {"label":"Enter", "x":11.25, "y":1, "w":1.75}, {"label":"4", "x":13, "y":1}, {"label":"5", "x":14, "y":1}, {"label":"6", "x":15, "y":1}, {"label":"-", "x":16, "y":1},
+				{"label":"Shift", "x":0, "y":2, "w":1.75}, {"label":"Z", "x":1.75, "y":2}, {"label":"X", "x":2.75, "y":2}, {"label":"C", "x":3.75, "y":2}, {"label":"V", "x":4.75, "y":2}, {"label":"B", "x":5.75, "y":2}, {"label":"N", "x":6.75, "y":2}, {"label":"M", "x":7.75, "y":2}, {"label":"<", "x":8.75, "y":2}, {"label":">", "x":9.75, "y":2}, {"label":"Shift", "x":10.75, "y":2, "w":1.25}, {"label":"&uarr;", "x":12, "y":2}, {"label":"1", "x":13, "y":2}, {"label":"2", "x":14, "y":2}, {"label":"3", "x":15, "y":2}, {"label":"+", "x":16, "y":2},
+				{"label":"Ctrl", "x":0, "y":3, "w":1.25}, {"label":"GUI", "x":1.25, "y":3, "w":1.25}, {"label":"Alt", "x":2.5, "y":3, "w":1.25}, {"x":3.75, "y":3, "w":1.75}, {"x":5.5, "y":3, "w":1}, {"label":"Backspace", "x":6.5, "y":3, "w":2.25}, {"label":"Menu", "x":8.75, "y":3, "w":1.25}, {"label":"Fn", "x":10, "y":3}, {"label":"&larr;", "x":11, "y":3}, {"label":"&darr;", "x":12, "y":3}, {"label":"&rarr;", "x":13, "y":3}, {"label":"0", "x":14, "y":3}, {"label":".", "x":15, "y":3}, {"label":"Enter", "x":16, "y":3}]
+        },
+        "LAYOUT_lefty": {
+            "layout": [
+                {"label":"7", "x":0, "y":0}, {"label":"8", "x":1, "y":0}, {"label":"9", "x":2, "y":0}, {"label":"-", "x":3, "y":0}, {"label":"Esc", "x":4, "y":0}, {"label":"Q", "x":5, "y":0}, {"label":"W", "x":6, "y":0}, {"label":"E", "x":7, "y":0}, {"label":"R", "x":8, "y":0}, {"label":"T", "x":9, "y":0}, {"label":"Y", "x":10, "y":0}, {"label":"U", "x":11, "y":0}, {"label":"I", "x":12, "y":0}, {"label":"O", "x":13, "y":0}, {"label":"P", "x":14, "y":0}, {"label":"{", "x":15, "y":0}, {"label":"}", "x":16, "y":0},
+                {"label":"4", "x":0, "y":1}, {"label":"5", "x":1, "y":1}, {"label":"6", "x":2, "y":1}, {"label":"+", "x":3, "y":1}, {"label":"Tab", "x":4, "y":1, "w":1.25}, {"label":"A", "x":5.25, "y":1}, {"label":"S", "x":6.25, "y":1}, {"label":"D", "x":7.25, "y":1}, {"label":"F", "x":8.25, "y":1}, {"label":"G", "x":9.25, "y":1}, {"label":"H", "x":10.25, "y":1}, {"label":"J", "x":11.25, "y":1}, {"label":"K", "x":12.25, "y":1}, {"label":"L", "x":13.25, "y":1}, {"label":":", "x":14.25, "y":1}, {"label":"Enter", "x":15.25, "y":1, "w":1.75},
+                {"label":"1", "x":0, "y":2}, {"label":"2", "x":1, "y":2}, {"label":"3", "x":2, "y":2}, {"x":3, "y":2}, {"label":"Shift", "x":4, "y":2, "w":1.75}, {"label":"Z", "x":5.75, "y":2}, {"label":"X", "x":6.75, "y":2}, {"label":"C", "x":7.75, "y":2}, {"label":"V", "x":8.75, "y":2}, {"label":"B", "x":9.75, "y":2}, {"label":"N", "x":10.75, "y":2}, {"label":"M", "x":11.75, "y":2}, {"label":"<", "x":12.75, "y":2}, {"label":">", "x":13.75, "y":2}, {"label":"\u2191", "x":14.75, "y":2}, {"label":"Shift", "x":15.75, "y":2, "w":1.25},
+                {"label":"Fn", "x":0, "y":3}, {"label":"0", "x":1, "y":3}, {"label":".", "x":2, "y":3}, {"label":"Enter", "x":3, "y":3}, {"label":"Ctrl", "x":4, "y":3, "w":1.25}, {"label":"Win", "x":5.25, "y":3, "w":1.25}, {"label":"Alt", "x":6.5, "y":3, "w":1.25}, {"x":7.75, "y":3, "w":1.75}, {"x":9.5, "y":3}, {"x":10.5, "y":3, "w":2.25}, {"label":"Win", "x":12.75, "y":3, "w":1.25}, {"label":"\u2190", "x":14, "y":3}, {"label":"\u2193", "x":15, "y":3}, {"label":"\u2192", "x":16, "y":3}
+            ]
        }
    }
-}
+}
@@ -0,0 +1,38 @@
+/* Copyright 2018 Jack Humbert
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include QMK_KEYBOARD_H
+
+#define _BL 0
+#define _FL 1
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+  /* Keymap _BL: Base Layer (Default Layer)
+   */
+[_BL] = LAYOUT_lefty(
+  KC_P7  , KC_P8, KC_P9  , KC_PAST, KC_ESC , KC_Q   , KC_W   , KC_E, KC_R   , KC_T  , KC_Y, KC_U   , KC_I   , KC_O   , KC_P   , KC_DEL , KC_BSPC , \
+  KC_P4  , KC_P5, KC_P6  , KC_PMNS, KC_TAB , KC_A   , KC_S   , KC_D, KC_F   , KC_G  , KC_H, KC_J   , KC_K   , KC_L   , KC_SCLN,          KC_ENT  , \
+  KC_P1  , KC_P2, KC_P3  , KC_PPLS, KC_LSFT,          KC_Z   , KC_X, KC_C   , KC_V  , KC_B, KC_N   , KC_M   , KC_COMM, KC_DOT , KC_UP   ,KC_RSFT , \
+  MO(_FL), KC_P0, KC_PDOT, KC_PENT, KC_LCTL, KC_LGUI, KC_LALT,                KC_SPC,       KC_SPC , KC_BSPC, KC_APP , KC_LEFT, KC_DOWN, KC_RGHT),
+
+  /* Keymap _FL: Function Layer
+  */
+  [_FL] = LAYOUT_lefty(
+  KC_P7 , KC_P8, KC_P9  , KC_VOLU, RESET  , KC_Q   , KC_W   , KC_E, KC_R   , KC_T  , KC_Y, KC_U   , KC_I   , KC_LBRC, KC_RBRC, KC_INS , KC_BSPC , \
+  KC_P4 , KC_P5, KC_P6  , KC_VOLD, KC_TAB , KC_A   , KC_SLCK, KC_D, KC_F   , KC_G  , KC_H, KC_J   , KC_K   , KC_L   , KC_QUOT,          KC_BSLS , \
+  KC_P1 , KC_P2, KC_P3  , KC_PEQL, KC_LSFT,          KC_Z   , KC_X, KC_CAPS, KC_V  , KC_B, KC_NLCK, KC_M   , KC_COMM, KC_DOT , KC_SLSH, KC_PGUP , \
+  KC_END, KC_P0, KC_PDOT, KC_PENT, KC_LCTL, KC_LGUI, KC_LALT,                KC_SPC,       KC_SPC , KC_BSPC, KC_APP , MO(_FL), KC_HOME, KC_PGDN),
+};
@@ -144,7 +144,7 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 };


-uint32_t layer_state_set_user(uint32_t state) {
+layer_state_t layer_state_set_user(layer_state_t state) {
  return update_tri_layer_state(state, _RAISE, _LOWER, _ADJUST);
 }

@@ -4,12 +4,16 @@

 A 65% keyboard that can be assembled with only through hole components, including usb type-c

-Keyboard Maintainer: [coseyfannitutti](https://github.com/coseyfannitutti)  
-Hardware Supported: DISCIPLINE, atmega32a  
-Hardware Availability: [cftkb.com](http://www.cftkb.com), [GitHub](https://github.com/coseyfannitutti/discipline)
+* Keyboard Maintainer: [coseyfannitutti](https://github.com/coseyfannitutti)
+* Hardware Supported: DISCIPLINE, atmega32a
+* Hardware Availability: [cftkb.com](http://www.cftkb.com), [GitHub](https://github.com/coseyfannitutti/discipline)

 Make example for this keyboard (after setting up your build environment):

    make coseyfannitutti/discipline:default

+Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
+
+    make coseyfannitutti/discipline:default:flash
+
 See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
@@ -0,0 +1,17 @@
+
+// generated from users/manna-harbour_miryoku/miryoku.org
+
+#pragma once
+
+#define EE_HANDS
+
+#ifdef RGB_MATRIX_ENABLE
+#define RGB_MATRIX_KEYPRESSES  // reacts to keypresses
+#define RGB_DISABLE_WHEN_USB_SUSPENDED true  // turn off effects when suspended
+#define RGB_MATRIX_FRAMEBUFFER_EFFECTS
+#define RGB_MATRIX_MAXIMUM_BRIGHTNESS 150 // limits maximum brightness of LEDs to 150 out of 255. Higher may cause the controller to crash.
+#define RGB_MATRIX_HUE_STEP 8
+#define RGB_MATRIX_SAT_STEP 8
+#define RGB_MATRIX_VAL_STEP 8
+#define RGB_MATRIX_SPD_STEP 10
+#endif
@@ -0,0 +1,4 @@
+
+# generated from users/manna-harbour_miryoku/miryoku.org
+
+RGB_MATRIX_ENABLE = WS2812
@@ -48,13 +48,13 @@ __attribute__((weak)) bool is_keyboard_left(void) {
 #elif defined(EE_HANDS)
    return eeconfig_read_handedness();
 #elif defined(MASTER_RIGHT)
-    return !is_keyboard_master();
+    return !has_usb();
 #endif

-    return is_keyboard_master();
+    return has_usb();
 }

-__attribute__((weak)) bool is_keyboard_master(void) {
+__attribute__((weak)) bool has_usb(void) {
    static enum { UNKNOWN, MASTER, SLAVE } usbstate = UNKNOWN;

    // only check once, as this is called often
@@ -103,8 +103,3 @@ void split_keyboard_setup(void) {
   }
   sei();
 }
-
-// backwards compat
-bool has_usb(void) {
-   return is_keyboard_master();
-}
@@ -194,6 +194,6 @@ bool process_record_user(uint16_t keycode, keyrecord_t *record) {
  return true;
 }

-uint32_t layer_state_set_user(uint32_t state) {
+layer_state_t layer_state_set_user(layer_state_t state) {
  return update_tri_layer_state(state, _RAISE, _LOWER, _ADJUST);
 }
@@ -2,44 +2,18 @@

 96 key atmega32a keyboard. 

-Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin)  
-Hardware Supported: Budget96 PCB  
-Hardware Availability: [DonutCables](https://donutcables.com/)  
+* Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin)
+* Hardware Supported: Budget96 PCB
+* Hardware Availability: [DonutCables](https://donutcables.com/)

 Make example for this keyboard (after setting up your build environment):

    make donutcables/budget96:default

-Flashing
+Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))

-**Reset Key:** Hold down the key located at `K00`, commonly programmed as left control while plugging in the keyboard.
+    make donutcables/budget96:default:flash

-ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods. 
-
-Windows: 
-1. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash).
-2. Place your keyboard into reset. 
-3. Press the `Find Device` button and ensure that your keyboard is found.
-4. Press the `Open .hex File` button and locate the `.hex` file you created.
-5. Press the `Flash Device` button and wait for the process to complete. 
-
-macOS:
-1. Install homebrew by typing the following:   
-    ```
-    /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
-    ```
-2. Install `crosspack-avr`.  
-    ```
-    brew cask install crosspack-avr
-    ```
-3. Install the following packages:
-    ```
-    brew install python3
-    pip3 install pyusb
-    brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
-    ```
-
-4. Place your keyboard into reset. 
-5. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file. 
+**Reset Key**: Hold down the key located at *K00*, commonly programmed as *left control* while plugging in the keyboard.

 See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
@@ -52,14 +52,14 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 // #define BACKLIGHT_BREATHING
 // #define BACKLIGHT_LEVELS 3

-// #define RGB_DI_PIN E2
-// #ifdef RGB_DI_PIN
-// #define RGBLIGHT_ANIMATIONS
-// #define RGBLED_NUM 16
-// #define RGBLIGHT_HUE_STEP 8
-// #define RGBLIGHT_SAT_STEP 8
-// #define RGBLIGHT_VAL_STEP 8
-// #endif
+#define RGB_DI_PIN D3
+#ifdef RGB_DI_PIN
+#define RGBLIGHT_ANIMATIONS
+#define RGBLED_NUM 2
+#define RGBLIGHT_HUE_STEP 8
+#define RGBLIGHT_SAT_STEP 8
+#define RGBLIGHT_VAL_STEP 8
+#endif

 /* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
 #define DEBOUNCE 5
@@ -15,20 +15,110 @@
 */
 #include QMK_KEYBOARD_H

+#ifdef RGBLIGHT_ENABLE
+//Following line allows macro to read current RGB settings
+extern rgblight_config_t rgblight_config;
+#endif

-const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
-  [0] = LAYOUT(
-    LCTL(KC_X), LCTL(KC_C), LCTL(KC_V), KC_UP, KC_DEL, KC_BSPC, \
-    KC_LCTRL, KC_LSFT, KC_LEFT, KC_DOWN, KC_RIGHT, KC_ENT \
-  ),
+enum layer_number {
+    _BASE = 0,
+    _LOWER,
+    _RAISE,
+    _ADJUST
 };

-bool process_record_user(uint16_t keycode, keyrecord_t *record) {
-  return true;
+enum custom_keycodes {
+  BASE = SAFE_RANGE,
+  LOWER,
+  RAISE,
+  ADJUST,
+  RGBRST
+};
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+  /* Base
+   * ,-----------------------------------------.
+   * |  Cut | Copy |Paste |  Up  |Delete| Bksp |
+   * |      |      |      |      |      |Raise |
+   * |------+------+------+------+------+------|
+   * | Ctrl |Shift | Left | Down |Right |Enter |
+   * |      |      |      |      |      |Lower |
+   * `-----------------------------------------'
+   */
+	[_BASE] = LAYOUT(
+    LCTL(KC_X), LCTL(KC_C), LCTL(KC_V), KC_UP, KC_DEL, LT(_RAISE,KC_BSPC),
+    KC_LCTL, KC_LSFT, KC_LEFT, KC_DOWN, KC_RGHT, LT(_LOWER,KC_ENT)
+  ),
+
+  /* Lower
+   * ,-----------------------------------------.
+   * |      |      |      | Page |      |      |
+   * |      |      |      |  Up  |      |      |
+   * |------+------+------+------+------+------|
+   * |      |      | Home | Page | End  |      |
+   * |      |      |      | Down |      |      |
+   * `-----------------------------------------'
+   */
+  [_LOWER] = LAYOUT(
+    _______, _______, _______, KC_PGUP, _______, _______,
+    _______, _______, KC_HOME, KC_PGDN, KC_END, _______
+  ),
+
+  /* Raise
+   * ,-----------------------------------------.
+   * |      |      |      |      |      |      |
+   * |      |      |      |      |      |      |
+   * |------+------+------+------+------+------|
+   * |      |      |      |      |      |      |
+   * |      |      |      |      |      |      |
+   * `-----------------------------------------'
+   */
+  [_RAISE] = LAYOUT(
+    _______, _______, _______, _______, _______, _______,
+    _______, _______, _______, _______, _______, _______
+  ),
+
+  /* Adjust
+   * ,-----------------------------------------.
+   * | RGB  | RGB  | RGB  | RGB  | RGB  |      |
+   * |Toggle|Mode+ | Hue+ | Sat+ | Val+ |      |
+   * |------+------+------+------+------+------|
+   * | RGB  | RGB  | RGB  | RGB  | RGB  |      |
+   * |Reset |Mode- | Hue- | Sat- | Val- |      |
+   * `-----------------------------------------'
+   */
+  [_ADJUST] = LAYOUT(
+    RGB_TOG, RGB_MOD, RGB_HUI, RGB_SAI, RGB_VAI, _______,
+    RGBRST, RGB_RMOD, RGB_HUD, RGB_SAD, RGB_VAD, _______
+  )
+};
+
+layer_state_t layer_state_set_user(layer_state_t state) {
+    return update_tri_layer_state(state, _LOWER, _RAISE, _ADJUST);
 }

-void matrix_init_user(void) {
+int RGB_current_mode;

+void matrix_init_user(void) {
+  #ifdef RGBLIGHT_ENABLE
+  RGB_current_mode = rgblight_config.mode;
+  #endif
+}
+
+bool process_record_user(uint16_t keycode, keyrecord_t *record) {
+
+  switch (keycode) {
+    case RGBRST:
+      #ifdef RGBLIGHT_ENABLE
+      if (record->event.pressed) {
+        eeconfig_update_rgblight_default();
+        rgblight_enable();
+        RGB_current_mode = rgblight_config.mode;
+      }
+      #endif
+      break;
+  }
+  return true;
 }

 void matrix_scan_user(void) {
@@ -1,8 +1,45 @@
 # The default keymap for Dozen0

+## Base
 ```
- ,-------------------------------------------------.
-| Ctrl+X | Ctrl+C | Ctrl+V |  Up  | Delete | Bksp  |
-|  Ctrl  | Shift  |  Left  | Down | Right  | Enter |
-`--------------------------------------------------'
+,-----------------------------------------.
+|  Cut | Copy |Paste |  Up  |Delete| Bksp |
+|      |      |      |      |      |Raise |
+|------+------+------+------+------+------|
+| Ctrl |Shift | Left | Down |Right |Enter |
+|      |      |      |      |      |Lower |
+`-----------------------------------------'
+```
+
+## Lower
+```
+,-----------------------------------------.
+|      |      |      | Page |      |      |
+|      |      |      |  Up  |      |      |
+|------+------+------+------+------+------|
+|      |      | Home | Page | End  |      |
+|      |      |      | Down |      |      |
+`-----------------------------------------'
+```
+
+## Raise
+```
+,-----------------------------------------.
+|      |      |      |      |      |      |
+|      |      |      |      |      |      |
+|------+------+------+------+------+------|
+|      |      |      |      |      |      |
+|      |      |      |      |      |      |
+`-----------------------------------------'
+```
+
+## Adjust
+```
+,-----------------------------------------.
+| RGB  | RGB  | RGB  | RGB  | RGB  |      |
+|Toggle|Mode+ | Hue+ | Sat+ | Val+ |      |
+|------+------+------+------+------+------|
+| RGB  | RGB  | RGB  | RGB  | RGB  |      |
+|Reset |Mode- | Hue- | Sat- | Val- |      |
+`-----------------------------------------'
 ```
@@ -18,8 +18,8 @@

 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  [0] = LAYOUT(
-    KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, \
-    KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12 \
+    KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6,
+    KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12
  ),
 };

@@ -9,25 +9,25 @@ MCU = atmega32u4
 #   QMK DFU      qmk-dfu
 #   ATmega32A    bootloadHID
 #   ATmega328P   USBasp
-BOOTLOADER = atmel-dfu
+BOOTLOADER = caterina

 # Build Options
 #   change yes to no to disable
 #
-BOOTMAGIC_ENABLE = no      # Virtual DIP switch configuration(+1000)
-MOUSEKEY_ENABLE = yes       # 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
+BOOTMAGIC_ENABLE = no       # Virtual DIP switch configuration
+MOUSEKEY_ENABLE = yes       # Mouse keys
+EXTRAKEY_ENABLE = yes       # Audio control and System control
+CONSOLE_ENABLE = no         # Console for debug
+COMMAND_ENABLE = no         # Commands for debug and configuration
 # Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE
 SLEEP_LED_ENABLE = no       # Breathing sleep LED during USB suspend
 # if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work
 NKRO_ENABLE = no            # USB Nkey Rollover
-BACKLIGHT_ENABLE = no       # Enable keyboard backlight functionality on B7 by default
-RGBLIGHT_ENABLE = no        # Enable keyboard RGB underglow
-MIDI_ENABLE = no            # MIDI support (+2400 to 4200, depending on config)
+BACKLIGHT_ENABLE = no       # Enable keyboard backlight functionality
+RGBLIGHT_ENABLE = yes       # Enable keyboard RGB underglow
+MIDI_ENABLE = no            # MIDI support
 UNICODE_ENABLE = no         # Unicode
 BLUETOOTH_ENABLE = no       # Enable Bluetooth with the Adafruit EZ-Key HID
 AUDIO_ENABLE = no           # Audio output on port C6
 FAUXCLICKY_ENABLE = no      # Use buzzer to emulate clicky switches
-HD44780_ENABLE = no 		# Enable support for HD44780 based LCDs (+400)
+HD44780_ENABLE = no         # Enable support for HD44780 based LCDs
@@ -1,7 +1,7 @@
 #pragma once
 #define XXX KC_NO
 #include "quantum.h"
-#define LAYOUT_HHKB( \
+#define LAYOUT_60_tsangan_hhkb( \
    K00, K01, K02, K03, K04, K05, K06, K07, K08, K09, K0A, K0B, K0C, K0D, K2C,\
    K10, K11, K12, K13, K14, K15, K16, K17, K18, K19, K1A, K1B, K1C, K1D,\
    K20, K21, K22, K23, K24, K25, K26, K27, K28, K29, K2A, K2B,      K2D,\
@@ -14,3 +14,5 @@
    { K30, K31, K32, K33, K34, K35, K36, K37, K38, K39, K3A, K3B, XXX, K3D },     \
    { K40, K41, K42, XXX, XXX, K45, XXX, XXX, XXX, XXX, K4A, K4B, XXX, K4D }      \
 }
+
+#define LAYOUT_HHKB LAYOUT_60_tsangan_hhkb
@@ -5,8 +5,8 @@
    "width": 15, 
    "height": 5, 
    "layouts": {
-        "LAYOUT_HHKB": {
+        "LAYOUT_60_tsangan_hhkb": {
            "layout": [{"x":0, "y":0}, {"x":1, "y":0}, {"x":2, "y":0}, {"x":3, "y":0}, {"x":4, "y":0}, {"x":5, "y":0}, {"x":6, "y":0}, {"x":7, "y":0}, {"x":8, "y":0}, {"x":9, "y":0}, {"x":10, "y":0}, {"x":11, "y":0}, {"x":12, "y":0}, {"x":13, "y":0}, {"x":14, "y":0}, {"x":0, "y":1, "w":1.5}, {"x":1.5, "y":1}, {"x":2.5, "y":1}, {"x":3.5, "y":1}, {"x":4.5, "y":1}, {"x":5.5, "y":1}, {"x":6.5, "y":1}, {"x":7.5, "y":1}, {"x":8.5, "y":1}, {"x":9.5, "y":1}, {"x":10.5, "y":1}, {"x":11.5, "y":1}, {"x":12.5, "y":1}, {"x":13.5, "y":1, "w":1.5}, {"x":0, "y":2, "w":1.75}, {"x":1.75, "y":2}, {"x":2.75, "y":2}, {"x":3.75, "y":2}, {"x":4.75, "y":2}, {"x":5.75, "y":2}, {"x":6.75, "y":2}, {"x":7.75, "y":2}, {"x":8.75, "y":2}, {"x":9.75, "y":2}, {"x":10.75, "y":2}, {"x":11.75, "y":2}, {"x":12.75, "y":2, "w":2.25}, {"x":0, "y":3, "w":2.25}, {"x":2.25, "y":3}, {"x":3.25, "y":3}, {"x":4.25, "y":3}, {"x":5.25, "y":3}, {"x":6.25, "y":3}, {"x":7.25, "y":3}, {"x":8.25, "y":3}, {"x":9.25, "y":3}, {"x":10.25, "y":3}, {"x":11.25, "y":3}, {"x":12.25, "y":3, "w":1.75}, {"x":14, "y":3}, {"x":0, "y":4, "w":1.5}, {"x":1.5, "y":4}, {"x":2.5, "y":4, "w":1.5}, {"x":4, "y":4, "w":7}, {"x":11, "y":4, "w":1.5}, {"x":12.5, "y":4}, {"x":13.5, "y":4, "w":1.5}]
        }
    }
-}
+}
@@ -5,19 +5,19 @@
 #define _LAYER3 3
 #define _LAYER4 4
 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
-		[_LAYER0] = LAYOUT_HHKB( /* Base */
+		[_LAYER0] = LAYOUT_60_tsangan_hhkb( /* Base */
 			      KC_GESC,         KC_1,    KC_2,    KC_3,    KC_4,    KC_5,     KC_6,   KC_7,   KC_8,    KC_9,    KC_0,    KC_MINS, KC_EQL,  KC_BSLS, KC_DEL,
 			      KC_TAB,          KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,     KC_Y,   KC_U,   KC_I,    KC_O,    KC_P,    KC_LBRC, KC_RBRC, KC_BSPC,
 				  CTL_T(KC_CAPS),  KC_A,    KC_S,    KC_D,    KC_F,    KC_G,     KC_H,   KC_J,   KC_K,    KC_L,    KC_SCLN, KC_QUOT,          KC_ENT,
 			      KC_LSFT,         KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,     KC_N,   KC_M,   KC_COMM, KC_DOT,  KC_SLSH, KC_RSFT,          MO(2),
 			      KC_LCTL,         KC_LGUI, KC_LALT,                   KC_SPACE,                                   KC_RALT, MO(1),            KC_RCTL),
-		[_LAYER1] = LAYOUT_HHKB( /* FN */
+		[_LAYER1] = LAYOUT_60_tsangan_hhkb( /* FN */
 				  KC_GRAVE, KC_F1,    KC_F2,    KC_F3,    KC_F4,    KC_F5,    KC_F6,    KC_F7,    KC_F8,    KC_F9,    KC_F10,   KC_F11,   KC_F12,   KC_TRNS, KC_TRNS, 
 	              KC_TRNS,  KC_TRNS,  KC_UP,    KC_TRNS,  KC_TRNS,  KC_TRNS,  KC_CALC,  KC_TRNS,  KC_INS,   KC_TRNS,  KC_PSCR,  KC_SLCK,  KC_PAUS,  RESET  ,
 			      KC_TRNS,  KC_LEFT,  KC_DOWN,  KC_RIGHT, KC_TRNS,  KC_TRNS,  KC_TRNS,  KC_TRNS,  KC_TRNS,  KC_TRNS,  KC_HOME,  KC_PGUP,            KC_TRNS,
 			      KC_MPRV,  KC_VOLD,  KC_VOLU,  KC_MUTE,  KC_TRNS,  KC_TRNS,  MAGIC_TOGGLE_NKRO,  KC_TRNS,  KC_TRNS,  KC_END,   KC_PGDOWN,KC_MNXT,            KC_TRNS,
 			      KC_TRNS,  KC_TRNS,  KC_TRNS,                      KC_TRNS,                                          KC_TRNS,  KC_TRNS,            KC_TRNS),
-		[_LAYER2] = LAYOUT_HHKB( /* FN2 */
+		[_LAYER2] = LAYOUT_60_tsangan_hhkb( /* FN2 */
 				  KC_TRNS,  KC_F1,    KC_F2,    KC_F3,    KC_F4,    KC_F5,    KC_F6,    KC_F7,    KC_F8,    KC_F9,    KC_F10,   KC_F11,   KC_F12,   KC_DEL ,KC_TRNS, 
 			  	  KC_TRNS,  RGB_TOG,  KC_TRNS,  RGB_HUI,  RGB_HUD,  RGB_SAI,  RGB_SAD,  RGB_VAI,  RGB_VAD,  RGB_MOD,  KC_TRNS,  KC_TRNS,  KC_TRNS,  RESET,
 				  KC_TRNS,  KC_TRNS,  KC_TRNS,  KC_TRNS,  KC_TRNS,  KC_TRNS,  KC_TRNS,  KC_TRNS,  RGB_SPI,  RGB_SPD,  KC_TRNS,  KC_TRNS,            KC_TRNS,
@@ -12,3 +12,5 @@ NKRO_ENABLE = yes                  # USB Nkey Rollover
 AUDIO_ENABLE = no
 RGB_MATRIX_ENABLE = IS31FL3733     # Use RGB matrix
 NO_USB_STARTUP_CHECK = no          # Disable initialization only when usb is plugged in
+
+LAYOUTS = 60_tsangan_hhkb
@@ -21,3 +21,5 @@ NKRO_ENABLE = yes                 # USB Nkey Rollover
 AUDIO_ENABLE = no
 RGB_MATRIX_ENABLE = IS31FL3733     # Use RGB matrix
 NO_USB_STARTUP_CHECK = no          # Disable initialization only when usb is plugged in
+
+LAYOUTS = 60_tsangan_hhkb
@@ -174,7 +174,7 @@ layer_state_t layer_state_set_user(layer_state_t state) {
  ergodox_right_led_2_off();
  ergodox_right_led_3_off();

-  uint8_t layer = biton32(state);
+  uint8_t layer = get_highest_layer(state);
  switch (layer) {
      case 0:
        #ifdef RGBLIGHT_COLOR_LAYER_0
@@ -13,9 +13,9 @@ const uint16_t PROGMEM fn_actions[] = {
  [1] = TT(1)
 };

-uint32_t layer_state_set_user(uint32_t state) {
+layer_state_t layer_state_set_user(layer_state_t state) {

-    uint8_t layer = biton32(state);
+    uint8_t layer = get_highest_layer(state);

    ergodox_led_all_off();
    ergodox_board_led_1_off();
@@ -2,50 +2,20 @@

 60% PCB with Function Row

-
-Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin)  
-Hardware Supported: EVE Meteor    
-Hardware Availability: [zFrontier](https://en.zfrontier.com/products/eve-meteor)  
-
+* Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin)
+* Hardware Supported: EVE Meteor
+* Hardware Availability: [zFrontier](https://en.zfrontier.com/products/eve-meteor)

 Make example for this keyboard (after setting up your build environment):

    make eve/meteor:default

-Flashing
+Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))

-ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods. 
+    make eve/meteor:default:flash

 **Reset Key:** Short the two holes labeled `FW_JP` underneath the PCB, beside the Tab key while plugging in the keyboard. 

 Do not confuse this with the LED holes of the switch in the `Tab` position. `FW_JP` is not reachable from the top as the plate blocks access to it. 

-It is recommended to program a `RESET` key in your keymap.   
-
-Windows: 
-1. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash).
-2. Place your keyboard into reset. 
-3. Press the `Find Device` button and ensure that your keyboard is found.
-4. Press the `Open .hex File` button and locate the `.hex` file you created.
-5. Press the `Flash Device` button and wait for the process to complete. 
-
-macOS:
-1. Install homebrew by typing the following:   
-    ```
-    /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
-    ```
-2. Install `crosspack-avr`.  
-    ```
-    brew cask install crosspack-avr
-    ```
-3. Install the following packages:
-    ```
-    brew install python3
-    pip3 install pyusb
-    brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
-    ```
-4. Place your keyboard into reset. 
-5. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file. 
-
-
 See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
@@ -2,43 +2,18 @@

 These docs are for the BMC version of the E6-V2 PCB sold during Round 2 which has an atmega32a microcontroller. Please do not flash this `.hex` file on your atmega32u4 equipped E6-V2 or your E6V2 BMC from Round 1. 

-Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin)  
-Hardware Supported: ps2avrgb E6-V2 with atmega32a microcontroller  
-Hardware Availability: [geekhack.org/index.php?topic=90787.0](https://geekhack.org/index.php?topic=90787.0)  
+* Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin)
+* Hardware Supported: ps2avrgb E6-V2 with atmega32a microcontroller
+* Hardware Availability: [geekhack.org/index.php?topic=90787.0](https://geekhack.org/index.php?topic=90787.0)

 Make example for this keyboard (after setting up your build environment):

    make exclusive/e6v2/le_bmc:default

-Flashing
+Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))

-ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods. 
+    make exclusive/e6v2/le_bmc:default:flash

-**Reset Key:**  Hold down the key located at `K00`, commonly programmed as left control while plugging in the keyboard. 
-
-Windows: 
-1. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash).
-2. Place your keyboard into reset. 
-3. Press the `Find Device` button and ensure that your keyboard is found.
-4. Press the `Open .hex File` button and locate the `.hex` file you created.
-5. Press the `Flash Device` button and wait for the process to complete. 
-
-macOS:
-1. Install homebrew by typing the following:   
-    ```
-    /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
-    ```
-2. Install `crosspack-avr`.  
-    ```
-    brew cask install crosspack-avr
-    ```
-3. Install the following packages:
-    ```
-    brew install python3
-    pip3 install pyusb
-    brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
-    ```
-4. Place your keyboard into reset. 
-5. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file. 
+**Reset Key**: Hold down the key located at *K00*, commonly programmed as *left control* while plugging in the keyboard.

 See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
@@ -2,43 +2,18 @@

 These docs are for the BMC version of the E6-V2 PCB sold during Round 1 which has an atmega32a microcontroller. Please do not flash this `.hex` file on your atmega32u4 equipped E6-V2 or your E6V2 BMC from Round 2. 

-Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin)  
-Hardware Supported: ps2avrgb E6-V2 with atmega32a microcontroller  
-Hardware Availability: [geekhack.org/index.php?topic=90787.0](https://geekhack.org/index.php?topic=90787.0)  
+* Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin)
+* Hardware Supported: ps2avrgb E6-V2 with atmega32a microcontroller
+* Hardware Availability: [geekhack.org/index.php?topic=90787.0](https://geekhack.org/index.php?topic=90787.0)

 Make example for this keyboard (after setting up your build environment):

    make exclusive/e6v2/oe_bmc:default

-Flashing
+Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))

-ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods. 
+    make exclusive/e6v2/oe_bmc:default:flash

-**Reset Key:**  Hold down the key located at `K00`, commonly programmed as left control while plugging in the keyboard. 
-
-Windows: 
-1. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash).
-2. Place your keyboard into reset. 
-3. Press the `Find Device` button and ensure that your keyboard is found.
-4. Press the `Open .hex File` button and locate the `.hex` file you created.
-5. Press the `Flash Device` button and wait for the process to complete. 
-
-macOS:
-1. Install homebrew by typing the following:   
-    ```
-    /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
-    ```
-2. Install `crosspack-avr`.  
-    ```
-    brew cask install crosspack-avr
-    ```
-3. Install the following packages:
-    ```
-    brew install python3
-    pip3 install pyusb
-    brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
-
-4. Place your keyboard into reset. 
-5. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file. 
+**Reset Key**: Hold down the key located at *K00*, commonly programmed as *left control* while plugging in the keyboard. 

 See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
@@ -2,9 +2,9 @@

 65% custom keyboard with large bezels. 

-Keyboard Maintainer: [mechmerlin](https://github.com/mechmerlin)  
-Hardware Supported: Exent PCB  
-Hardware Availability: [Geekhack GB](https://geekhack.org/index.php?topic=87213.0)  
+* Keyboard Maintainer: [mechmerlin](https://github.com/mechmerlin)
+* Hardware Supported: Exent PCB
+* Hardware Availability: [Geekhack GB](https://geekhack.org/index.php?topic=87213.0)

 Make example for this keyboard (after setting up your build environment):

@@ -14,6 +14,6 @@ Flashing example for this keyboard ([after setting up the bootloadHID flashing e

    make exent:default:flash

-**Reset Key**: Hold down the key located at `k0d`, commonly programmed as Backspace while plugging in the keyboard.
+**Reset Key**: Hold down the key located at `k0d`, commonly programmed as *Backspace* while plugging in the keyboard.

 See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
@@ -4,44 +4,18 @@ A 60% no frills keyboard.

 The FaceW is a special run of the WKL B.Face sourced from Sprit that doesn't have underglow RGB LEDs but does have in switch LEDs. Also unlike the B.Face, it is based on ps2avru instead of ps2avrGB. It is designed and manufactured in Korea. 

-Keyboard Maintainer: [MechMerlin](www.github.com/mechmerlin)  
-Hardware Supported: FaceW Sprit Edition PCB  
-Hardware Availability: https://mechanicalkeyboards.com/shop/index.php?l=product_detail&p=1352
+* Keyboard Maintainer: [MechMerlin](www.github.com/mechmerlin)
+* Hardware Supported: FaceW Sprit Edition PCB
+* Hardware Availability: <https://mechanicalkeyboards.com/shop/index.php?l=product_detail&p=1352>

 Make example for this keyboard (after setting up your build environment):

    make facew:default

-Flashing
+Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))

-ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods. 
-
-**Reset Key:** To put the FaceW into reset, hold `q` (`K01`) while plugging in.
-
-Windows: 
-1. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash).
-2. Place your keyboard into reset. 
-3. Press the `Find Device` button and ensure that your keyboard is found.
-4. Press the `Open .hex File` button and locate the `.hex` file you created.
-5. Press the `Flash Device` button and wait for the process to complete. 
-
-macOS:
-1. Install homebrew by typing the following:   
-    ```
-    /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
-    ```
-2. Install `crosspack-avr`.  
-    ```
-    brew cask install crosspack-avr
-    ```
-3. Install the following packages:
-    ```
-    brew install python3
-    pip3 install pyusb
-    brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
-
-4. Place your keyboard into reset. 
-5. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file. 
+    make facew:default:flash

+**Reset Key**: Hold down the key located at *K01*, commonly programmed as *q* while plugging in the keyboard.

 See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
@@ -155,7 +155,7 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {

 };

-uint32_t layer_state_set_user(uint32_t state) {
+layer_state_t layer_state_set_user(layer_state_t state) {
  return update_tri_layer_state(state, _LOWER, _RAISE, _ADJUST);
 }

@@ -2,43 +2,18 @@

 TKL Keyboard with in switch backlight and RGB Underglow. 

-Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin)  
-Hardware Supported: Mars 8.0 PCB  
-Hardware Availability: [Geekhack Group Buy](https://geekhack.org/index.php?topic=93723.0)  
+* Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin)
+* Hardware Supported: Mars 8.0 PCB
+* Hardware Availability: [Geekhack Group Buy](https://geekhack.org/index.php?topic=93723.0)

 Make example for this keyboard (after setting up your build environment):

    make ft/mars80:default

-Flashing
+Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))

-ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods. 
+    make ft/mars80:default:flash

 **Reset Key:** Hold down the key located at `K00`, commonly programmed as `Pause/Break` while plugging in the keyboard.

-Windows: 
-1. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash).
-2. Place your keyboard into reset. 
-3. Press the `Find Device` button and ensure that your keyboard is found.
-4. Press the `Open .hex File` button and locate the `.hex` file you created.
-5. Press the `Flash Device` button and wait for the process to complete. 
-
-macOS:
-1. Install homebrew by typing the following:   
-    ```
-    /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
-    ```
-2. Install `crosspack-avr`.  
-    ```
-    brew cask install crosspack-avr
-    ```
-3. Install the following packages:
-    ```
-    brew install python3
-    pip3 install pyusb
-    brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
-    ```
-4. Place your keyboard into reset. 
-5. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file. 
-
 See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
@@ -37,15 +37,15 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
   * |-----------------------------------------------------------|
   * |Shift   |  Z|  X|  C|  V|  B|  N|  M|  ,|  .|  /|Shift     |
   * |-----------------------------------------------------------|
-   * |Ctrl|Gui |Alt |         Space         |Alt |Gui |Fn  |Ctrl |
+   * |Ctrl|Gui |Alt |         Space         |Alt |Fn |Gui  |Ctrl |
   * `-----------------------------------------------------------'
   */
  [_QWERTY] = LAYOUT_60_ansi(
-    KC_GRV,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,      KC_7,    KC_8,    KC_9,    KC_0,    KC_MINS, KC_EQL,    KC_BSPC, \
-    HPR_TAB, KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,      KC_U,    KC_I,    KC_O,    KC_P,    KC_LBRC, KC_RBRC,   KC_BSLS, \
+    KC_GRV,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,      KC_7,    KC_8,    KC_9,    KC_0,    KC_MINS,   KC_EQL,  KC_BSPC, \
+    HPR_TAB, KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,      KC_U,    KC_I,    KC_O,    KC_P,    KC_LBRC,   KC_RBRC, KC_BSLS, \
    CTL_ESC, KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,      KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT,            KC_ENT,  \
    KC_LSFT,          KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,      KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH,            SFT_ENT, \
-    KC_LCTL, KC_LGUI, KC_LALT,                   KC_SPC,                                        KC_RALT, KC_RGUI, MO(_FUNC), KC_RCTL
+    KC_LCTL, KC_LGUI, KC_LALT,                   KC_SPC,                                        KC_RALT, MO(_FUNC), KC_RGUI, KC_RCTL
  ),

  /* Keymap _COLEMAK: (Base Layer) Default Layer
@@ -58,15 +58,15 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
   * |-----------------------------------------------------------|
   * |Shift   |  Z|  X|  C|  V|  B|  K|  M|  ,|  .|  /|Shift     |
   * |-----------------------------------------------------------|
-   * |Ctrl|Gui |Alt |         Space         |Alt |Gui |Fn  |Ctrl |
+   * |Ctrl|Gui |Alt |         Space         |Alt |Fn |Gui  |Ctrl |
   * `-----------------------------------------------------------'
   */
  [_COLEMAK] = LAYOUT_60_ansi(
-    KC_GRV,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,      KC_7,    KC_8,    KC_9,    KC_0,    KC_MINS, KC_EQL,    KC_BSPC, \
-    HPR_TAB, KC_Q,    KC_W,    KC_F,    KC_P,    KC_G,    KC_J,      KC_L,    KC_U,    KC_Y,    KC_SCLN, KC_LBRC, KC_RBRC,   KC_BSLS, \
+    KC_GRV,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,      KC_7,    KC_8,    KC_9,    KC_0,    KC_MINS,   KC_EQL,  KC_BSPC, \
+    HPR_TAB, KC_Q,    KC_W,    KC_F,    KC_P,    KC_G,    KC_J,      KC_L,    KC_U,    KC_Y,    KC_SCLN, KC_LBRC,   KC_RBRC, KC_BSLS, \
    CTL_ESC, KC_A,    KC_R,    KC_S,    KC_T,    KC_D,    KC_H,      KC_N,    KC_E,    KC_I,    KC_O,    KC_QUOT,            KC_ENT,  \
    KC_LSFT,          KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,      KC_K,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH,            SFT_ENT, \
-    KC_LCTL, KC_LGUI, KC_LALT,                   KC_SPC,                                        KC_RALT, KC_RGUI, MO(_FUNC), KC_RCTL
+    KC_LCTL, KC_LGUI, KC_LALT,                   KC_SPC,                                        KC_RALT, MO(_FUNC), KC_RGUI, KC_RCTL
  ),

  /* Keymap _DVORAK: (Base Layer) Default Layer
@@ -79,35 +79,35 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
   * |-----------------------------------------------------------|
   * |Shift   |  ;|  Q|  J|  K|  X|  B|  M|  W|  V|  Z|ShiftEnter|
   * |-----------------------------------------------------------|
-   * |Ctrl|Gui |Alt |         Space         |Alt |Gui |Fn  |Ctrl |
+   * |Ctrl|Gui |Alt |         Space         |Alt |Fn |Gui  |Ctrl |
   * `-----------------------------------------------------------'
   */
  [_DVORAK] = LAYOUT_60_ansi(
-    KC_GRV,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,      KC_7,    KC_8,    KC_9,    KC_0,    KC_LBRC, KC_RBRC,   KC_BSPC, \
-    HPR_TAB, KC_QUOT, KC_COMM, KC_DOT,  KC_P,    KC_Y,    KC_F,      KC_G,    KC_C,    KC_R,    KC_L,    KC_SLSH, KC_EQL,    KC_BSLS, \
+    KC_GRV,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,      KC_7,    KC_8,    KC_9,    KC_0,    KC_LBRC,   KC_RBRC, KC_BSPC, \
+    HPR_TAB, KC_QUOT, KC_COMM, KC_DOT,  KC_P,    KC_Y,    KC_F,      KC_G,    KC_C,    KC_R,    KC_L,    KC_SLSH,   KC_EQL,  KC_BSLS, \
    CTL_ESC, KC_A,    KC_O,    KC_E,    KC_U,    KC_I,    KC_D,      KC_H,    KC_T,    KC_N,    KC_S,    KC_MINS,            KC_ENT,  \
    KC_LSFT,          KC_SCLN, KC_Q,    KC_J,    KC_K,    KC_X,      KC_B,    KC_M,    KC_W,    KC_V,    KC_Z,               SFT_ENT, \
-    KC_LCTL, KC_LGUI, KC_LALT,                   KC_SPC,                                        KC_RALT, KC_RGUI, MO(_FUNC), KC_RCTL
+    KC_LCTL, KC_LGUI, KC_LALT,                   KC_SPC,                                        KC_RALT, MO(_FUNC), KC_RGUI, KC_RCTL
  ),

  /* Keymap _FUNC: Function Layer
   * ,-----------------------------------------------------------.
-   * |   | F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Delete |
+   * |   | F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|  BL   |
   * |-----------------------------------------------------------|
-   * |     |Hom| UP|End|   |   |   |Qwt|Cmk|Dvk|   |BL-|BL+|BL   |
+   * |     |Hom| UP|End|   |   |   |Qwt|Cmk|Dvk|   |UP |BL-| BL+ |
   * |-----------------------------------------------------------|
-   * |      |LFT| DN| RT|   |   |LFT| DN| UP| RT|Vo+|Pg+|        |
+   * |      |LFT| DN| RT|   |   |   |   |   |Pg+|LFT|RGT|        |
   * |-----------------------------------------------------------|
-   * |        |   |   |Prv|Ply|Nxt|   |   |   |Vo-|Pg-|          |
+   * |        |   |   |Prv|Ply|Nxt|   |   |   |Pg-|DN |          |
   * |-----------------------------------------------------------|
   * |RESET|    |    |                       |    |    |    |    |
   * `-----------------------------------------------------------'
   */
  [_FUNC] = LAYOUT_60_ansi(
-    _______, KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  KC_DEL,  \
-    _______, KC_HOME, KC_UP,   KC_END,  _______, _______, _______, QWERTY,  COLEMAK, DVORAK,  _______, BL_DEC,  BL_INC,  BL_TOGG, \
-    _______, KC_LEFT, KC_DOWN, KC_RGHT, _______, _______, KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT, KC_VOLU, KC_PGUP,          _______, \
-    _______,          _______, _______, KC_MPRV, KC_MPLY, KC_MNXT, _______, _______, _______, KC_VOLD, KC_PGDN,          _______, \
+    _______, KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  BL_TOGG, \
+    _______, KC_HOME, KC_UP,   KC_END,  _______, _______, _______, QWERTY,  COLEMAK, DVORAK,  _______, KC_UP,   BL_DEC,  BL_INC,  \
+    _______, KC_LEFT, KC_DOWN, KC_RGHT, _______, _______, _______, _______, _______, KC_PGUP, KC_LEFT, KC_RGHT,          _______, \
+    _______,          _______, _______, KC_MPRV, KC_MPLY, KC_MNXT, _______, _______, _______, KC_PGDN, KC_DOWN,          _______, \
    RESET,   _______, _______,                   _______,                                     _______, _______, _______, _______
  )
 };
@@ -4,45 +4,18 @@

 A Sony HitBit MSX Computer inspired Keyboard.

-Keyboard Maintainer: [Felipe Coury](https://github.com/fcoury)  
-Hardware Supported: Gray Studio HB85  
-Hardware Availability: [Group buy](https://en.zfrontier.com/products/gray-hb85) finished  
+* Keyboard Maintainer: [Felipe Coury](https://github.com/fcoury)
+* Hardware Supported: Gray Studio HB85
+* Hardware Availability: [Group buy](https://en.zfrontier.com/products/gray-hb85) finished

 Make example for this keyboard (after setting up your build environment):

    make gray_studio/hb85:default

-Flashing
+Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))

-ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods. 
+    make gray_studio/hb85:default:flash

 **Reset Key:** Hold down the key located at `K00`, commonly programmed as F3 while plugging in the keyboard.

-Windows: 
-1. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash).
-2. Place your keyboard into reset. 
-3. Press the `Find Device` button and ensure that your keyboard is found.
-4. Press the `Open .hex File` button and locate the `.hex` file you created.
-5. Press the `Flash Device` button and wait for the process to complete. 
-
-macOS:
-1. Install homebrew by typing the following:   
-    ```
-    /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
-    ```
-2. Install `crosspack-avr`.  
-    ```
-    brew cask install crosspack-avr
-    ```
-3. Install the following packages:
-    ```
-    brew install python3
-    pip3 install pyusb
-    brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
-
-4. Place your keyboard into reset. 
-5. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file. 
-
-**Please Note:** You will need to use the `EEP_RST` keycode first, followed by unplugging/replugging the board to get RGB underglow effects to work.
-
 See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
@@ -193,7 +193,7 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {

 };

-uint32_t layer_state_set_user(uint32_t state) {
+layer_state_t layer_state_set_user(layer_state_t state) {
  return update_tri_layer_state(state, _LOWER, _RAISE, _ADJUST);
 }

@@ -267,4 +267,3 @@ void matrix_init_user(void) {

 void matrix_scan_user(void) {
 }
-
@@ -143,7 +143,7 @@ layer_state_t layer_state_set_user(layer_state_t state)
 {
    turn_off_leds();

-    switch (biton32(state))
+    switch (get_highest_layer(state))
    {
    case NORMAL_LAYER:
 	break;
@@ -50,8 +50,8 @@ KC_GRAVE, KC_1,   KC_2,   KC_3,   KC_4,   KC_5,   KC_6,   KC_7,   KC_8,   KC_9,
 };

 /* Layer based ilumination, just binary */
-uint32_t layer_state_set_user(uint32_t state) {
-  switch (biton32(state)) {
+layer_state_t layer_state_set_user(layer_state_t state) {
+  switch (get_highest_layer(state)) {
  case _FNONE:
    palSetPad(GPIOA, 0);  //OFF Color A
    palClearPad(GPIOA, 1); //ON Color B
@@ -0,0 +1,18 @@
+# Cans12er
+![Cans12er](https://i.imgur.com/ZsO6QSI.jpg)
+
+A 12-key, orthogonal keypad designed by Can!
+
+* Keyboard Maintainer: [Can](https://github.com/canbaytok)
+* Hardware Supported: Pro Micro Atmega32u4
+* Hardware Availability: DIY with the [open-source design files](https://github.com/canbaytok/Cans12er)
+
+Schematic can be found here: [EasyEDA](https://easyeda.com/senordoenermann/mediapad)
+
+Build Instructions can be found here: [canbaytok/Cans12er](https://github.com/canbaytok/Cans12er)
+
+Make example for this keyboard (after setting up your build environment):
+
+    make handwired/cans12er:default
+
+See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
@@ -0,0 +1 @@
+#include "cans12er.h"
@@ -0,0 +1,13 @@
+#pragma once
+
+#include "quantum.h"
+
+#define LAYOUT_ortho_3x4( \
+	K00, K01, K02, K03, \
+	K10, K11, K12, K13, \
+	K20, K21, K22, K23  \
+) { \
+	{ K00,   K01,   K02,   K03 }, \
+	{ K10,   K11,   K12,   K13 }, \
+	{ K20,   K21,   K22,   K23 }  \
+}
@@ -0,0 +1,38 @@
+#pragma once
+
+#include "config_common.h"
+
+/* USB Device descriptor parameter */
+#define VENDOR_ID       0xFEED
+#define PRODUCT_ID      0x6060
+#define DEVICE_VER      0x0001
+#define MANUFACTURER    Can
+#define PRODUCT         cans12er
+#define DESCRIPTION     a simple 3x4 keypad. every part can be manufactured at home
+
+/* key matrix size */
+#define MATRIX_ROWS 3
+#define MATRIX_COLS 4
+
+/* key matrix pins */
+#define MATRIX_ROW_PINS { F7, B1, B3 }
+#define MATRIX_COL_PINS { D0, D4, C6, D7 }
+#define UNUSED_PINS
+
+/* COL2ROW or ROW2COL */
+#define DIODE_DIRECTION ROW2COL
+
+/* number of backlight levels */
+
+#ifdef BACKLIGHT_PIN
+#define BACKLIGHT_LEVELS 0
+#endif
+
+/* Set 0 if debouncing isn't needed */
+#define DEBOUNCE 5
+
+/* Mechanical locking support. Use KC_LCAP, KC_LNUM or KC_LSCR instead in keymap */
+#define LOCKING_SUPPORT_ENABLE
+
+/* Locking resynchronize hack */
+#define LOCKING_RESYNC_ENABLE
@@ -0,0 +1,20 @@
+// This is the canonical layout file for the Quantum project. If you want to add another keyboard,
+// this is the style you want to emulate.
+
+#include QMK_KEYBOARD_H
+
+// Each layer gets a name for readability, which is then used in the keymap matrix below.
+// The underscores don't mean anything - you can have a layer called STUFF or any other name.
+// Layer names don't all need to be of the same length, obviously, and you can also skip them
+// entirely and just use numbers.
+
+#define _KEYPAD 0
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+
+[_KEYPAD] = LAYOUT_ortho_3x4(
+		KC_A, KC_B, KC_C, KC_D, 
+		KC_E, KC_F, KC_G, KC_H, 
+		KC_I, KC_J, KC_K, KC_L 
+),
+};
@@ -0,0 +1,32 @@
+# MCU name
+MCU = atmega32u4
+
+# Bootloader selection
+#   Teensy       halfkay
+#   Pro Micro    caterina
+#   Atmel DFU    atmel-dfu
+#   LUFA DFU     lufa-dfu
+#   QMK DFU      qmk-dfu
+#   ATmega32A    bootloadHID
+#   ATmega328P   USBasp
+BOOTLOADER = atmel-dfu
+
+# Build Options
+#   comment out to disable the options.
+#
+BOOTMAGIC_ENABLE = lite      # Virtual DIP switch configuration
+MOUSEKEY_ENABLE = yes       # Mouse keys
+EXTRAKEY_ENABLE = yes       # Audio control and System control
+CONSOLE_ENABLE = no         # Console for debug
+COMMAND_ENABLE = no         # Commands for debug and configuration
+# Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE
+SLEEP_LED_ENABLE = no       # Breathing sleep LED during USB suspend
+# if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work
+NKRO_ENABLE = yes           # USB Nkey Rollover
+BACKLIGHT_ENABLE = no       # Enable keyboard backlight functionality
+RGBLIGHT_ENABLE = no        # Enable keyboard RGB underglow
+MIDI_ENABLE = no            # MIDI support
+BLUETOOTH_ENABLE = no       # Enable Bluetooth with the Adafruit EZ-Key HID
+AUDIO_ENABLE = no           # Audio output on port C6
+FAUXCLICKY_ENABLE = no      # Use buzzer to emulate clicky switches
+HD44780_ENABLE = no         # Enable support for HD44780 based LCDs
@@ -74,7 +74,7 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 ),
 };

-uint32_t layer_state_set_user(uint32_t state) {
+layer_state_t layer_state_set_user(layer_state_t state) {
  return update_tri_layer_state(state, _LOWER, _RAISE, _ADJUST);
 }

@@ -1,10 +1,12 @@
 #include "jotanck.h"

 void matrix_init_kb(void) {
-  matrix_init_user();
+    matrix_init_user();
 }

-void keyboard_pre_init_user() {
-  setPinOutput(JOTANCK_LED1);
-  setPinOutput(JOTANCK_LED2);
+void keyboard_pre_init_kb() {
+    setPinOutput(JOTANCK_LED1);
+    setPinOutput(JOTANCK_LED2);
+    
+    keyboard_pre_init_user();
 }
@@ -78,9 +78,9 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
    
 };

-uint32_t layer_state_set_user(uint32_t state) {
+layer_state_t layer_state_set_user(layer_state_t state) {
  #ifdef JOTANCK_LEDS
-  switch (biton32(state)) {
+  switch (get_highest_layer(state)) {
  case _LOWER:
    writePinHigh(JOTANCK_LED1);
    writePinLow(JOTANCK_LED2);
@@ -132,9 +132,9 @@ void led_set_user(uint8_t usb_led) {
 }

 //function for layer indicator LED
-uint32_t layer_state_set_user(uint32_t state)
+layer_state_t layer_state_set_user(layer_state_t state)
 {
-    if (biton32(state) == 2) {
+    if (get_highest_layer(state) == 2) {
    writePinHigh(C6);
 	} else {
 		writePinLow(C6);
@@ -986,7 +986,7 @@ void process_doublespace(bool pressed, bool *isactive, bool *otheractive, bool *
 }
 #endif

-uint32_t layer_state_set_kb(uint32_t state)
+layer_state_t layer_state_set_user(layer_state_t state)
 {
  // turn on punc layer if both fun & num are on
  if ((state & ((1UL<<_NUM) | (1UL<<_FUN))) == ((1UL<<_NUM) | (1UL<<_FUN))) {
@@ -99,6 +99,6 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {

 };

-uint32_t layer_state_set_user(uint32_t state) {
+layer_state_t layer_state_set_user(layer_state_t state) {
  return update_tri_layer_state(state, _LOWER, _RAISE, _ADJUST);
 }
@@ -102,7 +102,7 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 )
 };

-uint32_t layer_state_set_user(uint32_t state) {
+layer_state_t layer_state_set_user(layer_state_t state) {
  return update_tri_layer_state(state, _LOWER, _RAISE, _ADJUST);
 }

@@ -87,7 +87,7 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 float tone_qwerty[][2]     = TONE_QWERTY;
 float tone_numpad[][2]     = TONE_NUMPAD;

-uint32_t default_layer_state_set_kb(uint32_t state) {
+layer_state_t default_layer_state_set_kb(layer_state_t state) {
    if (state == 1UL<<_QWERTY) {
      PLAY_SONG(tone_qwerty);
    } else if (state == 1UL<<_NUMPAD) {
@@ -75,9 +75,9 @@ bool process_record_user(uint16_t keycode, keyrecord_t *record) {
  return true;
 }

-uint32_t layer_state_set_user(uint32_t state)
+layer_state_t layer_state_set_user(layer_state_t state)
 {
-	uint8_t layer=biton32(state);
+	uint8_t layer=get_highest_layer(state);
 	switch(layer)
 	{
 		case DF:
@@ -0,0 +1,49 @@
+/* Copyright 2019 HELIAR MK
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#pragma once
+
+#include "config_common.h"
+
+/* USB Device descriptor parameter */
+#define VENDOR_ID       0xFEED
+#define PRODUCT_ID      0xD070
+#define DEVICE_VER      0x0001
+#define MANUFACTURER    Heliar 
+#define PRODUCT         wm1 hotswap
+#define DESCRIPTION     69% custom keyboard
+
+/* key matrix size */
+#define MATRIX_ROWS 5
+#define MATRIX_COLS 15
+
+/*
+ * Keyboard Matrix Assignments
+ *
+ * Change this to how you wired your keyboard
+ * COLS: AVR pins used for columns, left to right
+ * ROWS: AVR pins used for rows, top to bottom
+ * DIODE_DIRECTION: COL2ROW = COL = Anode (+), ROW = Cathode (-, marked on diode)
+ *                  ROW2COL = ROW = Anode (+), COL = Cathode (-, marked on diode)
+ *
+*/
+#define MATRIX_ROW_PINS { D5, D3, B3, F0, E6 }
+#define MATRIX_COL_PINS { D2, B0, B1, B2, D1, D0, C7, C6, B6, B5, B4, F4, F5, F6, F1 }
+
+#define DIODE_DIRECTION COL2ROW
+
+#define BACKLIGHT_PIN B7
+#define BACKLIGHT_LEVELS 3
@@ -0,0 +1,81 @@
+{
+    "keyboard_name": "wm1",
+    "url": "",
+    "maintainer": "heliar",
+    "width": 18.25,
+    "height": 5.25,
+    "layouts": {
+        "LAYOUT": {
+            "layout": [
+                {"label": "k00", "x": 0, "y": 0},
+                {"label": "k01", "x": 1, "y": 0},
+                {"label": "k02", "x": 2, "y": 0},
+                {"label": "k03", "x": 3, "y": 0},
+                {"label": "k04", "x": 4, "y": 0},
+                {"label": "k05", "x": 5, "y": 0},
+                {"label": "k06", "x": 6, "y": 0},
+                {"label": "k07", "x": 9, "y": 0},
+                {"label": "k08", "x": 10, "y": 0},
+                {"label": "k09", "x": 11, "y": 0},
+                {"label": "k0a", "x": 12, "y": 0},
+                {"label": "k0b", "x": 13, "y": 0},
+                {"label": "k0c", "x": 14, "y": 0},
+                {"label": "k0d", "x": 15, "y": 0, "w": 2},
+                {"label": "k0e", "x": 17.25, "y": 0},
+                {"label": "k10", "x": 0, "y": 1, "w": 1.5},
+                {"label": "k11", "x": 1.5, "y": 1},
+                {"label": "k12", "x": 2.5, "y": 1},
+                {"label": "k13", "x": 3.5, "y": 1},
+                {"label": "k14", "x": 4.5, "y": 1},
+                {"label": "k15", "x": 5.5, "y": 1},
+                {"label": "k16", "x": 8.5, "y": 1},
+                {"label": "k17", "x": 9.5, "y": 1},
+                {"label": "k18", "x": 10.5, "y": 1},
+                {"label": "k19", "x": 11.5, "y": 1},
+                {"label": "k1a", "x": 12.5, "y": 1},
+                {"label": "k1b", "x": 13.5, "y": 1},
+                {"label": "k1c", "x": 14.5, "y": 1},
+                {"label": "k1d", "x": 15.5, "y": 1, "w": 1.5},
+                {"label": "k1e", "x": 17.25, "y": 1},
+                {"label": "k20", "x": 0, "y": 2, "w": 1.75},
+                {"label": "k21", "x": 1.75, "y": 2},
+                {"label": "k22", "x": 2.75, "y": 2},
+                {"label": "k23", "x": 3.75, "y": 2},
+                {"label": "k24", "x": 4.75, "y": 2},
+                {"label": "k25", "x": 5.75, "y": 2},
+                {"label": "k26", "x": 8.75, "y": 2},
+                {"label": "k27", "x": 9.75, "y": 2},
+                {"label": "k28", "x": 10.75, "y": 2},
+                {"label": "k29", "x": 11.75, "y": 2},
+                {"label": "k2a", "x": 12.75, "y": 2},
+                {"label": "k2b", "x": 13.75, "y": 2},
+                {"label": "k2d", "x": 14.75, "y": 2, "w": 2.25},
+                {"label": "k2e", "x": 17.25, "y": 2},
+                {"label": "k30", "x": 0, "y": 3, "w": 2.25},
+                {"label": "k31", "x": 2.25, "y": 3},
+                {"label": "k32", "x": 3.25, "y": 3},
+                {"label": "k33", "x": 4.25, "y": 3},
+                {"label": "k34", "x": 5.25, "y": 3},
+                {"label": "k35", "x": 6.25, "y": 3},
+                {"label": "k36", "x": 8.25, "y": 3},
+                {"label": "k37", "x": 9.25, "y": 3},
+                {"label": "k38", "x": 10.25, "y": 3},
+                {"label": "k39", "x": 11.25, "y": 3},
+                {"label": "k3a", "x": 12.25, "y": 3},
+                {"label": "k3b", "x": 13.25, "y": 3},
+                {"label": "k3c", "x": 14.25, "y": 3, "w": 1.75},
+                {"label": "k3d", "x": 16.25, "y": 3.25},
+                {"label": "k40", "x": 0, "y": 4, "w": 1.5},
+                {"label": "k42", "x": 3, "y": 4, "w": 1.5},
+                {"label": "k43", "x": 4.5, "y": 4},
+                {"label": "k44", "x": 5.5, "y": 4, "w": 2},
+                {"label": "k46", "x": 8.25, "y": 4, "w": 2.75},
+                {"label": "k49", "x": 11, "y": 4, "w": 1.5},
+                {"label": "k4b", "x": 13.5, "y": 4, "w": 1.5},
+                {"label": "k4c", "x": 15.25, "y": 4.25},
+                {"label": "k4d", "x": 16.25, "y": 4.25},
+                {"label": "k4e", "x": 17.25, "y": 4.25}
+            ]
+        }
+    }
+}
@@ -0,0 +1,23 @@
+#include QMK_KEYBOARD_H
+
+// Defines names for use in layer keycodes and the keymap
+enum layer_names {
+    _BASE,
+    _FN
+};
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+[_BASE] = LAYOUT(
+KC_GESC,   KC_1,   KC_2,   KC_3,   KC_4,   KC_5,   KC_6,   KC_7,   KC_8,   KC_9,    KC_0,    KC_MINS,   KC_EQL,   KC_BSPC,  KC_ESC,
+KC_TAB,    KC_Q,   KC_W,   KC_E,   KC_R,   KC_T,   KC_Y,   KC_U,   KC_I,   KC_O,    KC_P,    KC_LBRC,   KC_RBRC,  KC_BSLS,  KC_INS,
+KC_CAPS,   KC_A,   KC_S,   KC_D,   KC_F,   KC_G,   KC_H,   KC_J,   KC_K,   KC_L,    KC_SCLN, KC_QUOT,             KC_ENT,   KC_DEL,
+KC_LSFT,   KC_Z,   KC_X,   KC_C,   KC_V,   KC_B,   KC_B,   KC_N,   KC_M,   KC_COMM, KC_DOT,  KC_SLSH,   KC_RSFT,  KC_UP,
+KC_LCTL,           KC_LALT,KC_LGUI,KC_SPC,         LT(_FN,KC_SPC),         KC_RALT,          KC_RCTL,   KC_LEFT,  KC_DOWN,  KC_RIGHT),
+
+[_FN] = LAYOUT(
+KC_GRV,     KC_F1,    KC_F2,    KC_F3,    KC_F4,    KC_F5,    KC_F6,    KC_F7,    KC_F8,    KC_F9,   KC_F10,   KC_F11,  KC_F12,   _______,  _______,
+RESET,    _______,  _______,  _______,  _______,  _______,  _______,  _______,  _______,  _______,  _______,  _______,  _______,  _______,  _______,
+_______,  _______,  _______,  _______,  _______,  _______,  _______,  _______,  _______,  _______,  _______,  _______,            _______,  _______,
+_______,  _______,  _______,  BL_TOGG,  _______,  _______,  _______,  _______,  _______,  _______,  _______,  _______,  _______,  _______,
+_______,            _______,  _______,            _______,            _______,            _______,            _______,  _______,  _______,  _______),
+};
@@ -0,0 +1,7 @@
+# The default layout 
+## layer 0 keymap
+![Wm1 Layout Image Layer0](https://i.imgur.com/UWQzasE.png)
+## layer 1 keymap
+![Wm1 Layout Image Layer1](https://i.imgur.com/cHOefMH.png)
+## The keycap size of layout
+![Wm1 Layout Image Layout size](https://i.imgur.com/jL1EDod.png)
--- a/Show More
+++ b/Show More
Author	SHA1	Message	Date
iKirin	b386ccc786	Fix install for Linux Ubuntu (#7520 ) * Fix linux install for Ubuntu. It failed due to sh not supporting [ and pip being seperate from python3 * Adapted install function according to feedback * Fix style	2019-12-02 08:56:38 +11:00
skullY	0ed492978a	Add pep8-naming to our python linting	2019-12-01 13:40:14 -08:00
John Helveston	a2c6257942	[Keymap] Added jhelvy keymaps for keebio/iris and lily58 (#7447 ) * Added jhelvy keymaps for keebio/iris and lily58 * Fixed keymap image link for Iris * Update keyboards/keebio/iris/keymaps/jhelvy/keymap.c * Fixed keymap image url for lily58 * Update keyboards/lily58/keymaps/jhelvy/keymap.c * Removed numbers in parentheticals in lily58 rules * Removed unnecessary rules	2019-12-01 12:54:57 -08:00
QMK Bot	a14c9a057a	format code according to conventions [skip ci]	2019-12-01 16:23:14 +00:00
yulei	c9838fea12	[Keyboard] fixed noah info.json (#7518 ) * fixed noah info.json * fixed iso keymap and adding default iso keymaps * keymap cleanup * verified through the qmk configurator preview mode * modify encoding from utf-8 bom to urf-8	2019-12-01 08:20:45 -08:00
Drashna Jaelre	dfe18b40aa	[Keyboard] Update Lets Split Sockets to use LTO_ENABLE (#7516 )	2019-12-01 14:35:29 +00:00
fauxpark	f099142004	Add _summary.md for Russian docs with proper language prefix (#7514 )	2019-11-30 13:01:41 +00:00
Drashna Jaelre	d98ed28e7c	[Keyboard] Fix calls in handwired/jotanck (#7515 ) The C file for this keyboard was calling `keyboard_pre_init_user`. Which is wrong. This fixes that behavior.	2019-11-30 12:54:57 +00:00
hvp	beb9f3ab71	[Keymap] Added my UT47.2 Swedish layout with tap dance function. (#6861 ) * Added my UT47.2 Swedish layout with tap dance function. * Move tap dance over to user space * Removed config_common from config file	2019-11-29 23:39:54 -08:00
fauxpark	77c04d148e	Specify Arm GCC 8 in macOS install script (#7509 )	2019-11-29 16:44:18 -08:00
fauxpark	90c74701aa	[Keyboard] Add community layout support for DZ60RGB WKL (#7503 ) * Add community layout support for DZ60RGB WKL * info.json would be good too	2019-11-29 15:50:36 -08:00
yulei	ede67df6bd	[Keyboard] fixed noah info.json (#7502 ) * fixed noah info.json * fixed iso keymap and adding default iso keymaps * keymap cleanup * verified through the qmk configurator preview mode	2019-11-29 15:48:55 -08:00
Manna Harbour	27bf464dc3	[Keymap] Add RGB keycodes to keymap, enable RGB_MATRIX on crkbd (#7499 )	2019-11-29 15:48:11 -08:00
fauxpark	fb02593bd4	Use os.chdir for `qmk docs` instead of a custom HTTP request handler (#7493 )	2019-11-29 15:45:22 -08:00
Callum Oakley	c0dbd81b2b	[keymap] personal keymap tweaks (#7510 ) * replace home and end with cmd-left and cmd-right for iOS compatability * tab left and right with cmd-shift-bracket instead of ctrl-tab for Blink compatability * cmd-up and cmd-down instead of pg-up pg-down for blink shell compatability * Revert "cmd-up and cmd-down instead of pg-up pg-down for blink shell compatability" This reverts commit e976af9f11f77933f272edc22faf971445a65717. * reorganised symbol layer * update link in readme	2019-11-30 09:10:01 +11:00
Nick Brassel	385454e602	Fix output file permissions when using docker build. (#7378 )	2019-11-29 13:01:21 +00:00
fauxpark	7164e8eeb5	Add yet another dictionary for the QMK Firmware docs sidebar heading (#7504 )	2019-11-28 22:14:04 +00:00
Manna Harbour	f9521ffa21	Add shift-to-invert to remaining directional RGB_* keycode pairs (#7484 ) * Add shift-to-invert to remaining directional RGB_* keycode pairs RGB_MODE_FORWARD / RGB_MODE_REVERSE invert their functions when shift is held. This change adds the same capabilities to the remaining directional RGB_* keycode pairs. This improves consistency and provides full RGB control in a keymap containing only one keycode from each pair. * remove redundant variable * fix typo * Fix more typos Flyspell is on now I swear!	2019-11-28 22:00:29 +00:00
Joel Challis	2048df8832	Compile out some keycode processing when features are disabled (#7506 )	2019-11-28 21:59:59 +00:00
Joel Challis	99f3321e26	Fix processing of RGB keycodes on slave half (#7404 )	2019-11-28 21:59:14 +00:00
Joel Challis	235da6973d	Install bootloadHid as part of qmk_install (#7463 ) * Install bootloadHid on macos * Install bootloadHid on windows * Highlight bootloadHID is now installed in docs * Update udev rules for bootloadHID * Install bootloadHid on some distros * fix caterina udev filename	2019-11-28 15:29:11 +00:00
stanrc85	5c41fa6062	[Keymap] Userspace updates (#7500 ) * Convert macro to use new QMK CLI and other cleanup * use \n instead of ss enter	2019-11-27 22:55:29 -08:00
MechMerlin	99a58aa2b8	[Keyboard] New Keyboard: J-01 (#7494 ) * initial commit * create the appropriate LAYOUT macro * ANSI FOREVER * Update keyboards/jae/j01/config.h Changing it to use the Esc key for bootmagic lite * Update keyboards/jae/j01/readme.md * Update keyboards/jae/j01/readme.md * Update keyboards/jae/j01/info.json * Update keyboards/jae/j01/readme.md * Update keyboards/jae/j01/info.json * remove file as per fauxpark comments	2019-11-27 18:50:35 -08:00
James Young	4ae87ab40a	Community Layout support (and minor tidying) for KBD8X MK2 (#7449 ) * Community Layout support for KBD8X MK2 - add LAYOUT_tkl_ansi and LAYOUT_tkl_iso layout macros - add default_tkl_iso keymap, using new layout macro - rename ansi_625 keymap to default_tkl_ansi, using new layout macro - change keymaps to four-space indent - update info.json - remove firmware size impacts from rules.mk * remove empty functions * rename the ANSI and ISO keymaps per fauxpark	2019-11-27 22:16:18 +00:00
XScorpion2	7e62705877	Revert split encoder fixes until able to repro a better fix (#7498 ) Temporarily removing to avoid disabling split keyboards with Rotary Encoders, irisv3/4 and Sol, while @XScorpion2 works on a more permanent fix.	2019-11-27 14:04:30 -08:00
Yan-Fa Li	1604f79623	clean up quantum.c (#7485 ) * idea * progress * more stuff * wip * wip * last couple of keycodes you can move safely * Update quantum/quantum.c Co-Authored-By: fauxpark <fauxpark@gmail.com> * Put back RGB_MODE_BREATHE	2019-11-27 14:00:23 -08:00
yulei	265c415f5e	adding noah keyboard (#7432 ) * adding noah keyboard * Update keyboards/matrix/noah/config.h Co-Authored-By: Drashna Jaelre <drashna@live.com> * Update keyboards/matrix/noah/noah.c Co-Authored-By: Drashna Jaelre <drashna@live.com>	2019-11-27 07:54:02 -08:00
heliarmk	2b318ba01b	[Keyboard] add keyboard wm1 (#7466 ) * add new keyborad wm1 * 删除print信息 * add info.json and modified the default keymap.c * add keyboard name and maintainer in info.json * add readme.md file for new keyboard * add default/keymap/readme.md * modified the main readme file * change keyboard name from wm1 to wm1_hotswap * update readme * update imgur link in readme * update readme to add more pic and subtopic * change wm1 keyboard pic to direct show up * add copyright to config.h * modified the info.json to change the label * set the debug config to no in rule.mk * rename wn1.c wm1.h to wm1_hotswap.c, wm1_hotswap.h * fix spelling mistake * update the rule.mk to new version * fix the LED operation in wm1_hotswap.c * delete the definition of kc_trns * change layout to conform to electrical position * delete backslashes in keymap.c * update info.json according to the layout * change the return of led_update_kb * delete unused comments in rule.mk * delete unused definition in wm1_hotswap.h * add a if statement to support user override func * fix comment in rules.mk	2019-11-26 16:51:32 -08:00
Stephen Tudor	2f3adc3e24	Adjust Fn key and right arrow cluster of GH60/Satan keymap (#7490 )	2019-11-26 23:23:29 +00:00
James Young	57581ad733	Fix typos in stale.yml (#7489 )	2019-11-26 21:45:18 +00:00
Kemmel-Dev	b663a5b248	[Keymap] added a KBD67v2 layout that allows swapping of num/sym keys and f-rows (#7469 )	2019-11-26 10:28:44 -08:00
moyi4681	f6ffa28b27	[Keyboard] change xbows/knight pins of capslock Indicator (#7486 )	2019-11-26 10:02:42 -08:00
fauxpark	170261328e	Add language prefixes to docs sidebar entries and readmes (#7406 ) * Add language prefixes to docs sidebar entries and readmes * Remove prefix where it doesn't belong	2019-11-26 18:22:13 +11:00
fauxpark	5a6737a778	Send string keycode tweaks (#7471 )	2019-11-25 23:16:58 -08:00
Thomas Baart	a2cedf4555	[Keymap] Added keymap for Tessachka (#7457 ) * Added keymap for Tessachka * Update keyboards/kyria/keymaps/tessachka/keymap.c Co-Authored-By: Drashna Jaelre <drashna@live.com> * Update keyboards/kyria/keymaps/tessachka/rules.mk Co-Authored-By: Drashna Jaelre <drashna@live.com>	2019-11-25 22:51:58 -08:00
Salicylic-acid3	397897180b	[Keyboard] Add keyboard 7skb (#7468 ) * Add keyboard 7skb Add 7skb keyboard. A 63 keys HHKB Layout keyboard. Salicylic-acid3 * Update keyboards/7skb/keymaps/default/keymap.c * Update keyboards/7skb/keymaps/default/keymap.c * Update keyboards/7skb/keymaps/default/keymap.c * Update keyboards/7skb/keymaps/salicylic/keymap.c * Update keyboards/7skb/readme.md * Update keyboards/7skb/readme.md * Update keyboards/7skb/readme.md * keymap update Remove extra parts * Delete rules.mk * Update keyboards/7skb/rev1/rev1.c	2019-11-25 20:46:03 -08:00
fauxpark	36cde567ab	[Core] Remove PROGRAM_CMD in mcu_selection.mk for 32A (#7482 )	2019-11-25 19:51:40 -08:00
Martin Kauppinen	572d3329eb	[Keyboard] Add hand swap config matrix for preonic rev 3 (#7460 ) * Add hand swap config matrix for preonic rev 3 * Refactor hand swap config matrix into revision source files	2019-11-25 13:38:23 -08:00
yiancar	c0fe8dbfb4	IS31FL3733 Dirty page fix (#7079 ) * IS31FL3733 Dirty page fix Function IS31FL3733_update_led_control_registers was never setting update register to false. As a result the led on/off page was being written every transaction even when it was not modified. This is ineficient and causes lots of bandwidth use. -> Fix the IS31FL3733_update_led_control_registers. -> After testing it was evident that failed I2C transactions could corrupt the Led on/off register. -> Update IS31FL3733_write_pwm_buffer and IS31FL3733_write_register functions to return 0 upon succesful tranmission and 1 if any of the transmitions within the function fail. -> Modify IS31FL3733_update_pwm_buffers function so if any of the IS31FL3733_write_pwm_buffer transuction fails, the g_led_control_registers_update_required register is set to true forcing a rewrite of the led on/off register in case it was corrupted. * Minor comment update * Upsie:) * Update is31fl3733.c * Return fix * more return fix * type change * more boolian logic reversal:)	2019-11-25 20:33:52 +00:00
Joel Challis	f0f161e572	Remove vusb 'reset to bootloader' hid message due to security implications (#7456 )	2019-11-25 20:33:02 +00:00
Takeshi ISHII	3a7085dee4	fix link in docs/translating.md (#7474 )	2019-11-25 00:37:08 +00:00
yynmt	583094aa26	Add RGB LED for Dozen0 (#7458 ) * enable rgb led. * add layer for default keymap * Update keymap.c * Update rules.mk * Update rules.mk * fix keymaps remove backslashes.	2019-11-24 20:35:03 +11:00
Rob Rogers	f4fb0e1617	[Keyboard] Add candybar lefty layout (#7286 ) * Add left number pad layout to candybar keyboard * successfully builds * Rename new layout to LAYOUT_lefty and add corresponding LAYOUT_righty as alias for LAYOUT * merge * Add lefty keymap * Add lefty layout to info.json * Added LAYOUT_righty to info.json and corrected some misplaced braces * Update keyboards/candybar/info.json * removed redundant sections as suggested.	2019-11-23 23:37:09 -08:00
Joel Challis	6a8c0a6468	[Keyboard] Update ATmega32A readme files to match template (#7462 ) * Update atmega32a readme files to match template * Update atmega32a readme files to match template - fixes * Apply suggestions from code review	2019-11-23 20:42:20 -08:00
Can Baytok	d14573620d	[Keyboard] Added Cans12er keyboard (#7455 ) * added cans12er keyboard * updated readme Updated the readme to conform with the provided template from the qmk_firmware githubpage * Update keyboards/cans12er/README.md Co-Authored-By: James Young <18669334+noroadsleft@users.noreply.github.com> * Changed configuration Changed the configuration based on the Change Request from PR #7455 made by github user noroadsleft	2019-11-23 16:56:18 -08:00
fauxpark	9ea9806d67	Set up language fallback for docs, and update translation guidelines (#7403 ) * Set up language fallback for docs, and update translation guidelines * Title Case * Add ID example * Link to emoji flag cheatsheet * Move docs preview section to contributing.md * Point to docs preview in the readme	2019-11-23 16:07:15 +00:00
a_p_u_r_o	7874f297b3	Remove CR when computing BOOTLOADER_SIZE. (#7453 )	2019-11-24 03:01:03 +11:00
Yan-Fa Li	3541f01a72	Update led_update_kb example (#7451 ) * Update led_update_kb example * Update comment to explain pin behavior * wordsmith * wordsmithing 2	2019-11-23 15:37:25 +00:00
Hilary B. Brenum	eae21eed74	[Keymap] Adding hbbisenieks keymap for keebio/iris (#7440 ) * hbbisenieks keymap * fixed right encoder * changes suggested during pr	2019-11-22 14:40:18 -08:00
Yan-Fa Li	e62ab7e259	Allow overriding of all functions in wonderland.c (#7198 ) * f * Allow overriding of all functions in wonderland.c - needed for custom LED functions in keymap.c * Example of layer indication via LEDs optimize * Use newer led_update_kb and led_update_user hooks - these allow overriding without use of __attribute((weak))__ * Update led documentation a bit - clarify some of the wording around how to use led_update_user * Update led_update_user example * Update audio example to be complete * trailing spaces smh * spaces * spaces * smh * Less code is good * Update docs/custom_quantum_functions.md Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update docs/custom_quantum_functions.md Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update docs/custom_quantum_functions.md Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update docs/custom_quantum_functions.md Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update docs/custom_quantum_functions.md Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update docs/custom_quantum_functions.md Co-Authored-By: fauxpark <fauxpark@gmail.com>	2019-11-22 12:55:45 -08:00
dsanchezseco	0270d4d5a1	[Keymap] changed knight ridder offset to face me on planck (#7445 ) * added rgblight controls to planck keymap * fixed knight ridder offset to face me	2019-11-22 10:26:45 -08:00
Joel Challis	7e9ed2acbf	Fix clang-format logic within CI (#7386 )	2019-11-22 17:02:55 +00:00
Drashna Jaelre	66d4734371	Improve and streamline MSYS2 installation (#7232 ) * Make MSYS force install * Cleanup msys script * Update to gcc 8.3 for arm and avr And cleanup install scripts for both * Fix path and scripts * Fix links * No confirmation for msys * Tweak arm function since file structure changed * Fix spacing and wording Co-Authored-By: fauxpark <fauxpark@gmail.com> * Only use MSYS2's make binary Co-Authored-By: fauxpark <fauxpark@gmail.com> * Some wordsmithing Co-Authored-By: Mikkel Jeppesen <2756925+Duckle29@users.noreply.github.com> * Add "disable download timeout" for download issues in MSYS Co-Authored-By: Mikkel Jeppesen <2756925+Duckle29@users.noreply.github.com> * Clean up URL for arm gcc download Co-Authored-By: Joel Challis <git@zvecr.com> * add pip Co-Authored-By: fauxpark <fauxpark@gmail.com>	2019-11-22 18:09:02 +11:00
Drashna Jaelre	6cf574396a	[Keyboard] Update default keymaps to use `layer_state_t` (#7444 ) * Update default keymaps to use `layer_state_t` * Convert binon32 as get_highest_layer in default keymaps	2019-11-21 22:40:29 -08:00
dsanchezseco	f0a9c10b6d	[Keymap] added rgblight controls to planck keymap (#7439 )	2019-11-21 22:15:40 -08:00
fauxpark	78954a0d3e	[Keyboard] Add three missing layouts (#7441 ) * Add three missing default layouts * Add layout support to tragicforce68 * Not really 68% * Fix dumb mistake * Update info.json too * Apply suggestions from code review	2019-11-21 20:25:19 -08:00
fauxpark	02412156d5	Add 4-character aliases for sendstring keycodes (#7409 ) * Add 4-character aliases for sendstring keycodes * Remove pointless mail keycode redefinition * Forgot brightness keycodes	2019-11-22 14:11:28 +11:00
Thomas Baart	e70fef03c1	Updated Kyria readme.md with relocated build guide (#7438 )	2019-11-21 21:03:47 +00:00
Erovia	7e7eb69edf	MILC: Add support for hidden subcommands (#7034 ) * MILC: Add support for hidden subcommands Subcommands with 'hidden=True' will not show up in the help output, but will work as any other subcommands. * Hide those hidden submodules, for real now * Rebase on latest MILC	2019-11-21 12:52:00 -08:00