qmk-keychron-q3-colemak-dh/keyboards/zinc/keymaps/monks/readme_jp.md
James Young fced377ac0
2020 May 30 Breaking Changes Update (#9215)
* Branch point for 2020 May 30 Breaking Change

* Migrate `ACTION_LAYER_TOGGLE` to `TG()` (#8954)

* Migrate `ACTION_MODS_ONESHOT` to `OSM()` (#8957)

* Migrate `ACTION_DEFAULT_LAYER_SET` to `DF()` (#8958)

* Migrate `ACTION_LAYER_MODS` to `LM()` (#8959)

* Migrate `ACTION_MODS_TAP_KEY` to `MT()` (#8968)

* Convert V-USB usbdrv to a submodule (#8321)

* Unify Tap Hold functions and documentation (#8348)

* Changing board names to prevent confusion (#8412)

* Move the Keyboardio Model01 to a keyboardio/ subdir (#8499)

* Move spaceman keyboards (#8830)

* Migrate miscellaneous `fn_actions` entries (#8977)

* Migrate `ACTION_MODS_KEY` to chained mod keycodes (#8979)

* Organizing my keyboards (plaid, tartan, ergoinu) (#8537)

* Refactor Lily58 to use split_common (#6260)

* Refactor zinc to use split_common (#7114)

* Add a message if bin/qmk doesn't work (#9000)

* Fix conflicting types for 'tfp_printf' (#8269)

* Fixed RGB_DISABLE_AFTER_TIMEOUT to be seconds based & small internals cleanup (#6480)

* Refactor and updates to TKC1800 code (#8472)

* Switch to qmk forks for everything (#9019)

* audio refactor: replace deprecated PLAY_NOTE_ARRAY (#8484)

* Audio enable corrections (2/3) (#8903)

* Split HHKB to ANSI and JP layouts and Add VIA support for each (#8582)

* Audio enable corrections (Part 4) (#8974)

* Fix typo from PR7114 (#9171)

* Augment future branch Changelogs (#8978)

* Revert "Branch point for 2020 May 30 Breaking Change"
2020-05-30 13:14:59 -07:00

104 lines
3.7 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# monksoffunk's personal zinc Layout
## 配列
### Qwerty配列
```
,-----------------------------------------. ,-----------------------------------------.
| Tab | Q | W | E | R | T | | Y | U | I | O | P | Bksp |
|------+------+------+------+------+------| |------+------+------+------+------+------|
| Ctrl | A | S | D | F | G | | H | J | K | L | ; | ' |
|------+------+------+------+------+------| |------+------+------+------+------+------|
| Shift| Z | X | C | V | B | | N | M | , | . | / |Enter |
|------+------+------+------+------+------| |------+------+------+------+------+------|
| Esc |ADJUST| Alt | GUI |LOWER |Space | | Space| RAISE| KANA | Left | Down | Right|
`------------------------------------------ ------------------------------------------'
```
KANAキーを独立させ、UPキーをLOWERスラッシュに当てています。そのほかデフォルトからレイヤーをかなりいじっています。
また、RGB LEDがアンコメントしてありますので、実装していない場合はソースを見て適宜コメントアウトしてください。
## コンパイルの仕方
コンパイルは、qmk_firmware のトップディレクトリで行います。
```
$ cd qmk_firmware
```
qmk_firmwareでは各キーボードのコンパイルは、`<キーボード名>:<キーマップ名>`という指定で行います。
```
$ make zinc:monks
```
キーボードへの書き込みまで同時に行うには下記のように`:avrdude`を付けます。
```
$ make zinc:monks:avrdude
```
コンパイル結果と中間生成物を消去したい場合は以下のようにします。
```
$ make zinc:monks:clean
```
なお、avrdudeではなくQMK ToolboxGUIツールを使う方法もあります。
https://github.com/qmk/qmk_toolbox/releases
その場合は、$ make zinc:monksでビルドした成果物をQMK Toolboxから指定してください。
## カスタマイズ
コマンドラインからオプションを指定してビルドすることが出来ます。
```
# Zinc keyboard 'monks' keymap: convenient command line option
make ZINC=<options> zinc:monks
# option= back | under | na | ios
# ex.
# make ZINC=under zinc:monks
# make ZINC=under,ios zinc:monks
# make ZINC=back zinc:monks
# make ZINC=back,na zinc:monks
# make ZINC=back,ios zinc:monks
```
あるいは`qmk_firmware/keyboards/zinc/rev1/keymaps/monks/rules.mk` の以下の部分を編集して機能を有効化してください。
```
# Zinc keyboard customize
LED_BACK_ENABLE = no # LED backlight (Enable SK6812mini backlight)
LED_UNDERGLOW_ENABLE = no # LED underglow (Enable WS2812 RGB underlight)
LED_ANIMATIONS = yes # LED animations
IOS_DEVICE_ENABLE = no # connect to IOS device (iPad,iPhone)
```
## RGB backlight を有効にする
rules.mk の下記の部分を編集して no を yes に変更してください。
```
LED_BACK_ENABLE = yes # LED backlight (Enable SK6812mini backlight)
```
## RGB Underglow を有効にする
rules.mk の下記の部分を編集して no を yes に変更してください。
```
LED_UNDERGLOW_ENABLE = yes # LED underglow (Enable WS2812 RGB underlight)
```
## iPad/iPhoneサポートを有効にする。
rules.mk の下記の部分を編集して no を yes に変更してください。
RBG Underglow や RGBバックライトの輝度を抑えて、iPad, iPhone にも接続できるようになります。
```
IOS_DEVICE_ENABLE = no # connect to IOS device (iPad,iPhone)
```