qmk_firmware

QMK firmware for my keyboards (Corne, Sweep Ferris) and trackball (Ploopy Adept)
Log | Files | Refs | Submodules | LICENSE

readme.md (2046B)

      1 # Alish40
      2 
      3 ![Alish40 in black](https://i.imgur.com/h9lklc9l.jpg)
      4 
      5 A budget-friendly 40% Alice*ish* keyboard with base kit support and styl*ish* silkscreen art.
      6 
      7 * Keyboard Maintainer: [Reed](https://github.com/NamesReed), [Kyle McCreery](https://github.com/kylemccreery)
      8 * Hardware Supported: Alish40 v1.3
      9 * Hardware Availability: [Alish40, fulfilled by MechWild](https://mechwild.com/product/alish/)
     10 
     11 Make example for this keyboard (after setting up your build environment):
     12 
     13     make reedskeebs/alish40:default
     14 
     15 Flashing example for this keyboard:
     16 
     17     make reedskeebs/alish40:default:flash
     18 
     19 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).
     20 
     21 ## Bootloader
     22 
     23 Enter the bootloader in 3 ways:
     24 
     25 * **Bootmagic reset**: Hold down the top left key and plug in the keyboard. This will also clear EEPROM, so it is a good first step if the keyboard is misbehaving.
     26 * **Physical reset**: Press the 6x6mm button below the "Alish 40" label, on the underside of the PCB. You may also use your Pro Micro's built-in reset mechanism if that is easier.
     27 * **Keycode in layout**: There is no key mapped to `QK_BOOT` in the pre-created keymaps, but you may assign this key in any keymaps you create.
     28 
     29 As a Pro Micro-compatible board, the Alish40 uses `caterina` as its bootloader by default. Many popular Pro Micro alternatives like the Elite-C, Bit-C, Sea-Micro, Puchi-C etc should be flashed with a different bootloader such as `atmel-dfu`.
     30 
     31 **If the incorrect bootloader is specified, bootmagic reset and the `QK_BOOT` keycode will not work**.
     32 
     33 To avoid this problem, set the correct bootloader in your custom keymap's `rules.mk` file before compiling, or flash using an appropriate target (e.g. `make reedskeebs/alish40:default:dfu`). See [flashing instructions and bootloader information](https://docs.qmk.fm/#/flashing) for more details.