qmk_firmware

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

readme.md (2381B)


      1 # Kimiko
      2 
      3 ## Rev2
      4 
      5 A split keyboard with 4x6 vertically staggered keys and a Kyria style thumb thumb cluster.
      6 
      7 ![Kimiko Rev2](https://i.imgur.com/TBP8Bcrh.jpg)
      8 
      9 - Keyboard Maintainer: [BenRoe](https://github.com/BenRoe/) [@keycapsss](https://twitter.com/keycapsss)
     10 - Hardware Supported: Pro Micro 5V/16Mhz and compatible
     11 - Hardware Availability: [Keycapsss.com](https://keycapsss.com)
     12 
     13 ### Features (Rev2)
     14 
     15 - 62 Per key RGB led's (SK6812 Mini-E)
     16   - RGB Matrix is enabled as default in rules.mk
     17   - The effects can be configured in config.h
     18 - Support for 1 rotary encoder per side (two possible positions)
     19 - Support for 1 OLED display per side  
     20   - 128x32 (SSD1306) or Nice!View are supported  
     21   - With 1 OLED on each side, they have to be the same  
     22   - Default configuration for 128x32 OLED  
     23 
     24 
     25 Make firmware .hex for this keyboard (after setting up your build environment):
     26 
     27 ```bash
     28 qmk compile -kb keycapsss/kimiko/rev2 -km default
     29 ```
     30 
     31 Use [QMK Toolbox](https://github.com/qmk/qmk_toolbox) to flash the firmware hex file to the keyboard controller.
     32 
     33 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).
     34 
     35 ## Rev1
     36 
     37 A split keyboard with 4x6 vertically staggered keys and thumb keys.
     38 
     39 ![Kimiko Rev1](https://i.imgur.com/md6V6Eoh.jpg)
     40 
     41 - Keyboard Maintainer: [BenRoe](https://github.com/BenRoe/) [@keycapsss](https://twitter.com/keycapsss)
     42 - Hardware Supported: Pro Micro 5V/16Mhz and compatible
     43 - Hardware Availability: [Keycapsss.com](https://keycapsss.com)
     44 
     45 ### Features (Rev1)
     46 
     47 - Per key RGB led's (SK6812 Mini-E)
     48 - 6 underglow RGB led's per side (SK6812 Mini)
     49 - Support for 1 rotary encoder per side (two possible positions)
     50 
     51 Make firmware .hex for this keyboard (after setting up your build environment):
     52 
     53 ```bash
     54 qmk compile -kb keycapsss/kimiko/rev1 -km default
     55 ```
     56 
     57 Use [QMK Toolbox](https://github.com/qmk/qmk_toolbox) to flash the firmware hex file to the keyboard controller.
     58 
     59 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).