keyboards/zinc/keymaps/monks/readme_jp.md

   1 # monksoffunk's personal 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  |ADJUST| Alt  | GUI  |LOWER |Space |             | Space| RAISE| KANA | Left | Down | Right|
  15  `------------------------------------------             ------------------------------------------'
  16 ```
  17
  18 KANAキーを独立させ、UPキーをLOWER＋スラッシュに当てています。そのほかデフォルトからレイヤーをかなりいじっています。
  19 また、RGB LEDがアンコメントしてありますので、実装していない場合はソースを見て適宜コメントアウトしてください。
  20
  21 ## コンパイルの仕方
  22
  23 コンパイルは、qmk_firmware のトップディレクトリで行います。
  24
  25 ```
  26 $ cd qmk_firmware
  27 ```
  28 qmk_firmwareでは各キーボードのコンパイルは、`<キーボード名>:<キーマップ名>`という指定で行います。
  29
  30 ```
  31 $ make zinc:monks
  32 ```
  33
  34 キーボードへの書き込みまで同時に行うには下記のように`:avrdude`を付けます。
  35
  36 ```
  37 $ make zinc:monks:avrdude
  38 ```
  39
  40 コンパイル結果と中間生成物を消去したい場合は以下のようにします。
  41
  42 ```
  43 $ make zinc:monks:clean
  44 ```
  45
  46 なお、avrdudeではなくQMK Toolbox（GUIツール）を使う方法もあります。
  47
  48 https://github.com/qmk/qmk_toolbox/releases
  49
  50 その場合は、$ make zinc:monksでビルドした成果物をQMK Toolboxから指定してください。
  51
  52 ## カスタマイズ
  53
  54 コマンドラインからオプションを指定してビルドすることが出来ます。
  55
  56 ```
  57 # Zinc keyboard 'monks' keymap: convenient command line option
  58 make ZINC=<options> zinc:monks
  59 #    option= back | under | na | ios
  60 #    ex.
  61 #      make ZINC=under    zinc:monks
  62 #      make ZINC=under,ios zinc:monks
  63 #      make ZINC=back     zinc:monks
  64 #      make ZINC=back,na  zinc:monks
  65 #      make ZINC=back,ios zinc:monks
  66 ```
  67
  68 あるいは`qmk_firmware/keyboards/zinc/rev1/keymaps/monks/rules.mk` の以下の部分を編集して機能を有効化してください。
  69
  70 ```
  71 # Zinc keyboard customize
  72 LED_BACK_ENABLE = no        # LED backlight (Enable SK6812mini backlight)
  73 LED_UNDERGLOW_ENABLE = no   # LED underglow (Enable WS2812 RGB underlight)
  74 LED_ANIMATIONS = yes        # LED animations
  75 IOS_DEVICE_ENABLE = no      # connect to IOS device (iPad,iPhone)
  76
  77
  78 ```
  79
  80 ## RGB backlight を有効にする
  81
  82 rules.mk の下記の部分を編集して no を yes に変更してください。
  83 ```
  84 LED_BACK_ENABLE = yes   # LED backlight (Enable SK6812mini backlight)
  85 ```
  86
  87
  88 ## RGB Underglow を有効にする
  89
  90 rules.mk の下記の部分を編集して no を yes に変更してください。
  91 ```
  92 LED_UNDERGLOW_ENABLE = yes   # LED underglow (Enable WS2812 RGB underlight)
  93 ```
  94
  95
  96 ## iPad/iPhoneサポートを有効にする。
  97
  98 rules.mk の下記の部分を編集して no を yes に変更してください。
  99 RBG Underglow や RGBバックライトの輝度を抑えて、iPad, iPhone にも接続できるようになります。
 100
 101 ```
 102 IOS_DEVICE_ENABLE = no      # connect to IOS device (iPad,iPhone)
 103 ```