qmk_firmware

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

readme.md (1969B)


      1 # Rookey
      2 
      3 ![takashicompany/rookey](https://i.imgur.com/kLQDeZZh.jpg)
      4 
      5 Rookey, as the name implies, is a DIY keyboard "Rookie" creation.
      6 
      7 With its small number of parts and simple structure, it can be easily completed even by first-time assemblers.
      8 
      9 Despite its small size, it can be used as a 9-key macro pad, and a rotary encoder can also be attached.
     10 
     11 It can be used not only as a first unit, but also as a long-lasting unit.
     12 
     13 ---
     14 
     15 Rookeyは名前の通り、DIYキーボードの"Rookie"のために作られた一作です。
     16 
     17 部品数が少なく、構造がシンプルなため初めて組み立てる人でも容易に完成させることができます。
     18 
     19 小さいながらも9キーのマクロパッドとして使用ができる上に、ロータリーエンコーダの取り付けも可能です。
     20 
     21 初めての一台としてはもちろん、永く使い続ける一台としても愛用することができます。
     22 
     23 * Keyboard Maintainer: [takashicompany](https://github.com/takashicompany)
     24 * Hardware Supported: Rookey PCB, Pro Micro
     25 * Hardware Availability: https://github.com/takashicompany/rookey
     26 
     27 Make example for this keyboard (after setting up your build environment):
     28 
     29     make takashicompany/rookey:default
     30 
     31 Flashing example for this keyboard:
     32 
     33     make takashicompany/rookey:default:flash
     34 
     35 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).
     36 
     37 ## Bootloader
     38 
     39 Enter the bootloader in 3 ways:
     40 
     41 * **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard
     42 * **Physical reset button**: Briefly press the button on the back of the PCB - some may have pads you must short instead
     43 * **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available