qmk_firmware

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

readme_jp.md (8047B)


      1 # The Default Zinc Layout
      2 ## 配列
      3 
      4 ### Qwerty配列
      5 
      6 ```
      7  ,-----------------------------------------.             ,-----------------------------------------.
      8  | Tab  |   Q  |   W  |   E  |   R  |   T  |             |   Y  |   U  |   I  |   O  |   P  | Bksp |
      9  |------+------+------+------+------+------|             |------+------+------+------+------+------|
     10  | Ctrl |   A  |   S  |   D  |   F  |   G  |             |   H  |   J  |   K  |   L  |   ;  |  '   |
     11  |------+------+------+------+------+------|             |------+------+------+------+------+------|
     12  | Shift|   Z  |   X  |   C  |   V  |   B  |             |   N  |   M  |   ,  |   .  |   /  |Enter |
     13  |------+------+------+------+------+------|             |------+------+------+------+------+------|
     14  | Esc  |  Fn  | Alt  | Win  |Lower |Space |             | Space| Raise| Left | Down |  Up  | Right|
     15  `------------------------------------------             ------------------------------------------'
     16 ```
     17 
     18 ### Colemak
     19 
     20 ```
     21  ,-----------------------------------------.             ,-----------------------------------------.
     22  | Tab  |   Q  |   W  |   F  |   P  |   G  |             |   J  |   L  |   U  |   Y  |   ;  | Bksp |
     23  |------+------+------+------+------+------|             |------+------+------+------+------+------|
     24  | Ctrl |   A  |   R  |   S  |   T  |   D  |             |   H  |   N  |   E  |   I  |   O  |  '   |
     25  |------+------+------+------+------+------|             |------+------+------+------+------+------|
     26  | Shift|   Z  |   X  |   C  |   V  |   B  |             |   K  |   M  |   ,  |   .  |   /  |Enter |
     27  |------+------+------+------+------+------|             |------+------+------+------+------+------|
     28  | Esc  |ADJUST| Alt  | Win  |LOWER |Space |             | Space| RAISE| Left | Down |  Up  | Right|
     29  `------------------------------------------             ------------------------------------------'
     30 ```   
     31  
     32 ### Dvorak
     33 
     34 ```
     35  ,-----------------------------------------.             ,-----------------------------------------.
     36  | Tab  |   '  |   ,  |   .  |   P  |   Y  |             |   F  |   G  |   C  |   R  |   L  | Del  |
     37  |------+------+------+------+------+------|             |------+------+------+------+------+------|
     38  | Ctrl |   A  |   O  |   E  |   U  |   I  |             |   D  |   H  |   T  |   N  |   S  |  /   |
     39  |------+------+------+------+------+------|             |------+------+------+------+------+------|
     40  | Shift|   ;  |   Q  |   J  |   K  |   X  |             |   B  |   M  |   W  |   V  |   Z  |Enter |
     41  |------+------+------+------+------+------|             |------+------+------+------+------+------|
     42  | Esc  |ADJUST| Alt  | Win  |LOWER |Space |             | Space| RAISE| Left | Down |  Up  | Right|
     43  `-----------------------------------------'             `-----------------------------------------'
     44 ```
     45 
     46  ### Lower
     47 ```
     48  ,-----------------------------------------.             ,-----------------------------------------.
     49  |   ~  |   !  |   @  |   #  |   $  |   %  |             |   ^  |   &  |   *  |   (  |   )  |      |
     50  |------+------+------+------+------+------|             |------+------+------+------+------+------|
     51  |      |      |      |      |      |      |             |   -  |   _  |   +  |   {  |   }  |  |   |
     52  |------+------+------+------+------+------|             |------+------+------+------+------+------|
     53  |      |      |      |      |      |      |             |      |      |      | Home | End  |      |
     54  |------+------+------+------+------+------|             |------+------+------+------+------+------|
     55  |      |      |      |      |      |      |             |      |      | Next | Vol- | Vol+ | Play |
     56  `-----------------------------------------'             `-----------------------------------------'
     57 ```
     58 
     59 ### RAISE
     60 ```
     61  ,-----------------------------------------.             ,-----------------------------------------.
     62  |   `  |   1  |   2  |   3  |   4  |   5  |             |   6  |   7  |   8  |   9  |   0  | Del  |
     63  |------+------+------+------+------+------|             |------+------+------+------+------+------|
     64  |      |  F1  |  F2  |  F3  |  F4  |  F5  |             |  F6  |   -  |   =  |   [  |   ]  |  \   |
     65  |------+------+------+------+------+------|             |------+------+------+------+------+------|
     66  |      |  F7  |  F8  |  F9  |  F10 |  F11 |             |  F12 |      |      |      |      |
     67  |------+------+------+------+------+------|             |------+------+------+------+------+------|
     68  |      |      |      |      |      |      |             |      |      | Next | Vol- | Vol+ | Play |
     69  `-----------------------------------------'             `-----------------------------------------'
     70 ```
     71 
     72 ### Adjust (Lower + Raise)
     73 ```
     74  ,-----------------------------------------.             ,-----------------------------------------.
     75  |      | Reset|RGBRST|Aud on|Audoff|      |             |      |Qwerty|Colemk|Dvorak|      | Ins  |
     76  |------+------+------+------+------+------|             |------+------+------+------+------+------|
     77  |      |RGB ON| HUE+ | SAT+ | VAL+ | Mac  |             | Win  |  -   |   =  |Print |ScLock|Pause |
     78  |------+------+------+------+------+------|             |------+------+------+------+------+------|
     79  |MODE R|RGBMOD| HUE- | SAT- | VAL- |      |             |      |      |      |      |PageUp|      |
     80  |------+------+------+------+------+------|             |------+------+------+------+------+------|
     81  |      |      |      | EISU | EISU | EISU |             | KANA | KANA | KANA | Home |PageDn| End  |
     82  `-----------------------------------------'             `-----------------------------------------'
     83 ```
     84 
     85 ## コンパイルの仕方
     86 
     87 コンパイルは、qmk_firmware のトップディレクトリで行います。
     88 
     89 ```
     90 $ cd qmk_firmware
     91 ```
     92 qmk_firmwareでは各キーボードのコンパイルは、`<キーボード名>:<キーマップ名>`という指定で行います。
     93 
     94 ```
     95 $ make zinc:default
     96 ```
     97 
     98 キーボードへの書き込みまで同時に行うには下記のように`:avrdude`を付けます。
     99 
    100 ```
    101 $ make zinc:default:avrdude
    102 ```
    103 
    104 コンパイル結果と中間生成物を消去したい場合は以下のようにします。
    105 
    106 ```
    107 $ make zinc:default:clean
    108 ```
    109 
    110 ## カスタマイズ
    111 
    112 コマンドラインからオプションを指定してビルドすることが出来ます。
    113 
    114 ```
    115 # Zinc keyboard 'default' keymap: convenient command line option
    116 make ZINC=<options> zinc:defualt
    117 #    option= back | under | both | cont | na | ios
    118 #    ex.
    119 #      make ZINC=under    zinc:defualt
    120 #      make ZINC=under,ios zinc:defualt
    121 #      make ZINC=back     zinc:default
    122 #      make ZINC=back,na  zinc:default
    123 #      make ZINC=back,ios zinc:default
    124 ```
    125 
    126 あるいは`qmk_firmware/keyboards/zinc/rev1/keymaps/~/rules.mk` の以下の部分を直接編集して機能を有効化してください。
    127 
    128 ```
    129 # Zinc keyboard customize
    130 LED_BACK_ENABLE = no        # LED backlight (Enable SK6812mini backlight)
    131 LED_UNDERGLOW_ENABLE = no   # LED underglow (Enable WS2812 RGB underlight)
    132 LED_BOTH_ENABLE = no        # LED backlight and underglow
    133 LED_RGB_CONT = no           # LED continuous backlight or/and underglow between left Zinc and right Zinc
    134 LED_ANIMATIONS = yes        # LED animations
    135 IOS_DEVICE_ENABLE = no      # connect to IOS device (iPad,iPhone)
    136 ```
    137 
    138 ## RGB backlight を有効にする
    139 
    140 rules.mk の下記の部分を編集して no を yes に変更してください。
    141 ```
    142 LED_BACK_ENABLE = yes   # LED backlight (Enable SK6812mini backlight)
    143 ```
    144 
    145 
    146 ## RGB Underglow を有効にする
    147 
    148 rules.mk の下記の部分を編集して no を yes に変更してください。
    149 ```
    150 LED_UNDERGLOW_ENABLE = yes   # LED underglow (Enable WS2812 RGB underlight.)
    151 ```
    152 
    153 
    154 ## iPad/iPhoneサポートを有効にする。
    155 
    156 rules.mk の下記の部分を編集して no を yes に変更してください。
    157 RBG Underglow や RGBバックライトの輝度を抑えて、iPad, iPhone にも接続できるようになります。
    158 
    159 ```
    160 IOS_DEVICE_ENABLE = no      # connect to IOS device (iPad,iPhone)
    161 ```