mirror of
https://github.com/qmk/qmk_firmware.git
synced 2026-09-30 22:09:01 +02:00
add docusaurus, convert notes/tips, ids
This commit is contained in:
Jack Humbert
@@ -206,7 +206,11 @@ nose2、flake8 および yapf を使ってコードをテスト、リントお
|
||||
|
||||
[yapf](https://github.com/google/yapf) を使ってコードを自動的にフォーマットします。フォーマットの設定は `setup.cfg` の `[yapf]` セクションにあります。
|
||||
|
||||
?> ヒント- 多くのエディタは yapf をプラグインとして使って、入力したコードを自動的にフォーマットすることができます。
|
||||
:::tip
|
||||
|
||||
ヒント- 多くのエディタは yapf をプラグインとして使って、入力したコードを自動的にフォーマットすることができます。
|
||||
|
||||
:::
|
||||
|
||||
## テストの詳細
|
||||
|
||||
|
||||
@@ -12,11 +12,19 @@
|
||||
|
||||
ドロップダウンボックスをクリックして、キーマップを作成するキーボードを選択します。
|
||||
|
||||
?> **キーボードに複数のバージョンがある場合は、正しいバージョンを選択してください。**
|
||||
:::tip
|
||||
|
||||
**キーボードに複数のバージョンがある場合は、正しいバージョンを選択してください。**
|
||||
|
||||
:::
|
||||
|
||||
大事なことなのでもう一度言います。
|
||||
|
||||
!> **正しいバージョンを選択してください!**
|
||||
:::caution
|
||||
|
||||
**正しいバージョンを選択してください!**
|
||||
|
||||
:::
|
||||
|
||||
キーボードが QMK を搭載していると宣伝されていてもリストにない場合は、開発者がまだ作業中か、私たちがまだマージするきっかけがなかった可能性があります。
|
||||
アクティブな [プルリクエスト](https://github.com/qmk/qmk_firmware/pulls?q=is%3Aopen+is%3Apr+label%3Akeyboard) がない場合、[qmk_firmware](https://github.com/qmk/qmk_firmware/issues)で報告して、その特定のキーボードのサポートをリクエストします。
|
||||
@@ -31,7 +39,11 @@
|
||||
|
||||
お好みの名前をキーマップにつけます。
|
||||
|
||||
?> コンパイル時に問題が発生した場合は、もしかすると QMK ファームウェアリポジトリに既に同じ名前が存在しているのかもしれません。名前を変更してみてください。
|
||||
:::tip
|
||||
|
||||
コンパイル時に問題が発生した場合は、もしかすると QMK ファームウェアリポジトリに既に同じ名前が存在しているのかもしれません。名前を変更してみてください。
|
||||
|
||||
:::
|
||||
|
||||
## ステップ4: キーマップを定義する
|
||||
|
||||
@@ -41,12 +53,20 @@
|
||||
2. レイアウト上の空の場所をクリックして、希望するキーコードをクリックします
|
||||
3. レイアウト上の空の場所をクリックして、キーボードの物理キーを押します
|
||||
|
||||
?> マウスをキーの上に置くと、そのキーコードの機能の短い説明文が出ます。より詳細な説明については以下を見てください:
|
||||
:::tip
|
||||
|
||||
マウスをキーの上に置くと、そのキーコードの機能の短い説明文が出ます。より詳細な説明については以下を見てください:
|
||||
|
||||
:::
|
||||
|
||||
* [基本的なキーコードリファレンス](ja/keycodes_basic.md)
|
||||
* [高度なキーコードリファレンス](ja/feature_advanced_keycodes.md)
|
||||
|
||||
!> 選択したレイアウトが物理的なビルドと一致しない場合は、使用していないキーは空白のままにしておきます。どのキーが使用されているかわからない場合、例えば、バックスペースキーは1つだが `LAYOUT_all` には2つのキーがある場合は、同じキーコードを両方の場所に配置してください。
|
||||
:::caution
|
||||
|
||||
選択したレイアウトが物理的なビルドと一致しない場合は、使用していないキーは空白のままにしておきます。どのキーが使用されているかわからない場合、例えば、バックスペースキーは1つだが `LAYOUT_all` には2つのキーがある場合は、同じキーコードを両方の場所に配置してください。
|
||||
|
||||
:::
|
||||
|
||||
## ステップ5: 後日のためにキーマップを保存する
|
||||
|
||||
@@ -54,7 +74,11 @@
|
||||
これでキーマップがあなたのコンピュータに保存されます。
|
||||
その後、`Import Keymap` ボタンを押すことで、この .json ファイルを後で読み込むことができます。
|
||||
|
||||
!> **注意:** このファイルは、kbfirmware.com またはその他のツールに使用される .json ファイルと同じ形式ではありません。これらのツールにこの .json を使用したり、QMK Configurator でこれらのツールの .json を使用しようとすると、問題が発生します。
|
||||
:::caution
|
||||
|
||||
**注意:** このファイルは、kbfirmware.com またはその他のツールに使用される .json ファイルと同じ形式ではありません。これらのツールにこの .json を使用したり、QMK Configurator でこれらのツールの .json を使用しようとすると、問題が発生します。
|
||||
|
||||
:::
|
||||
|
||||
## ステップ6: ファームウェアをコンパイルする
|
||||
|
||||
|
||||
@@ -84,7 +84,11 @@ kerpleplork はエラーコード 23 で連続的に失敗していました。
|
||||
私が使用できるデバイスの限られた実験では、kerpleplork の混乱を避けるために 7 は十分高い値であることを示していますが、念のため ARM デバイスを持つ人たちからフィードバックを得たいです。
|
||||
```
|
||||
|
||||
!> **重要:** デフォルト以外のキーマップ、ユーザスペースおよびレイアウトのようなユーザコードへのバグ修正あるいは改善に貢献したい場合は、PR にコードの元の提出者にタグをつけてください。Git と GitHub のスキルレベルに関係なく、多くのユーザは知らないうちにコードが変更されることに混乱したりイライラしたりするかもしれません。
|
||||
:::caution
|
||||
|
||||
**重要:** デフォルト以外のキーマップ、ユーザスペースおよびレイアウトのようなユーザコードへのバグ修正あるいは改善に貢献したい場合は、PR にコードの元の提出者にタグをつけてください。Git と GitHub のスキルレベルに関係なく、多くのユーザは知らないうちにコードが変更されることに混乱したりイライラしたりするかもしれません。
|
||||
|
||||
:::
|
||||
|
||||
## ドキュメント
|
||||
|
||||
|
||||
@@ -103,7 +103,11 @@ keyrecord_t record {
|
||||
* `matrix_init_*` - ファームウェアのスタートアッププロセスの途中で起こります。ハードウェアは初期化されますが、機能はまだ初期化されていない場合があります。
|
||||
* `keyboard_post_init_*` - ファームウェアのスタートアッププロセスの最後に起こります。これはほとんどの場合、 "カスタマイズ"コードを配置する場所です。
|
||||
|
||||
!> ほとんどの人にとって、`keyboard_post_init_user` が呼び出したいものです。例えば、ここで RGB アンダーグローのセットアップを行います。
|
||||
:::caution
|
||||
|
||||
ほとんどの人にとって、`keyboard_post_init_user` が呼び出したいものです。例えば、ここで RGB アンダーグローのセットアップを行います。
|
||||
|
||||
:::
|
||||
|
||||
## キーボードの事前初期化コード
|
||||
|
||||
|
||||
@@ -30,22 +30,38 @@ This page covers my super cool feature. You can use this feature to make coffee,
|
||||
### 重要なもの
|
||||
|
||||
```
|
||||
!> This is important
|
||||
:::caution
|
||||
|
||||
This is important
|
||||
```
|
||||
|
||||
:::
|
||||
|
||||
以下のように表示されます:
|
||||
|
||||
!> This is important
|
||||
:::caution
|
||||
|
||||
This is important
|
||||
|
||||
:::
|
||||
|
||||
### 一般的なヒント
|
||||
|
||||
```
|
||||
?> This is a helpful tip.
|
||||
:::caution
|
||||
|
||||
This is a helpful tip.
|
||||
```
|
||||
|
||||
:::
|
||||
|
||||
以下のように表示されます:
|
||||
|
||||
?> This is a helpful tip.
|
||||
:::tip
|
||||
|
||||
This is a helpful tip.
|
||||
|
||||
:::
|
||||
|
||||
|
||||
# 機能を文章化する
|
||||
|
||||
@@ -26,7 +26,11 @@ Zadig は自動的にブートローダデバイスを検知します。**Option
|
||||
- QMK-DFU ブートローダを使って書き込まれた AVR キーボードは `<keyboard name> Bootloader` という名前が付けられ、VID は `03EB` です。
|
||||
- ほとんどの ARM キーボードでは、`STM32 BOOTLOADER` と呼ばれ、VID/PID は `0483:DF11` です。
|
||||
|
||||
!> Zadig が `HidUsb` ドライバを使用する1つ以上のデバイスを表示する場合、キーボードはおそらくブートローダモードではありません。矢印はオレンジ色になり、システムドライバの変更を確認するように求められます。この場合、続行**しないでください**！
|
||||
:::caution
|
||||
|
||||
Zadig が `HidUsb` ドライバを使用する1つ以上のデバイスを表示する場合、キーボードはおそらくブートローダモードではありません。矢印はオレンジ色になり、システムドライバの変更を確認するように求められます。この場合、続行**しないでください**！
|
||||
|
||||
:::
|
||||
|
||||
矢印が緑色で表示されたら、ドライバを選択し、**Install Driver** をクリックします。`libusb-win32` ドライバは通常 AVR で動作し、`WinUSB`は ARM で動作しますが、それでもキーボードに書き込みできない場合は、リストから異なるドライバをインストールしてみてください。USBAspLoader デバイスは `libusbK` ドライバを使わなければなりません。
|
||||
|
||||
|
||||
@@ -72,7 +72,11 @@ PLAY_LOOP(my_song);
|
||||
* `AU_OFF` - オーディオ機能をオフ
|
||||
* `AU_TOG` - オーディオ機能を切り替え
|
||||
|
||||
!> これらのキーコードは全てのオーディオ機能をオンおよびオフにします。オフにするとオーディオフィードバック、オーディオクリック、音楽モードなどが完全に無効になります。
|
||||
:::caution
|
||||
|
||||
これらのキーコードは全てのオーディオ機能をオンおよびオフにします。オフにするとオーディオフィードバック、オーディオクリック、音楽モードなどが完全に無効になります。
|
||||
|
||||
:::
|
||||
|
||||
## ARM オーディオボリューム
|
||||
|
||||
|
||||
@@ -65,7 +65,11 @@
|
||||
|
||||
完璧に動作するまで、いろいろな値を試してみます。多くの人は、全てが所定の値で適切に動作するものの、時々、1つあるいは2つのキーがシフト状態を発行することが分かるでしょう。これは単に習慣と、幾つかのキーを他のキーよりも少し長く押し続けることによるものです。この値を見つけたら、問題のキーを通常よりも少し早くタップするとともに、その値を設定します。
|
||||
|
||||
?> 自動シフトには、この値を素早く取得するのに役立つ3つの特別なキーがあります。詳細は「自動シフトのセットアップ」を見てください！
|
||||
:::tip
|
||||
|
||||
自動シフトには、この値を素早く取得するのに役立つ3つの特別なキーがあります。詳細は「自動シフトのセットアップ」を見てください！
|
||||
|
||||
:::
|
||||
|
||||
### NO_AUTO_SHIFT_SPECIAL (単純にこのように定義します)
|
||||
|
||||
|
||||
@@ -19,7 +19,11 @@
|
||||
BOOTMAGIC_ENABLE = yes
|
||||
```
|
||||
|
||||
?> `full` の代わりに `yes` が使われていることがあるかもしれませんが、これは問題ありません。ただし、`yes` は非推奨で、理想的には `full` (あるいは`lite`) が使われるべきです。
|
||||
:::tip
|
||||
|
||||
`full` の代わりに `yes` が使われていることがあるかもしれませんが、これは問題ありません。ただし、`yes` は非推奨で、理想的には `full` (あるいは`lite`) が使われるべきです。
|
||||
|
||||
:::
|
||||
|
||||
さらに、以下を `rules.mk` ファイルに追加することで、[ブートマジックライト](#bootmagic-lite) (スケールダウンした、とても基本的なバージョンのブートマジック)を使うことができます:
|
||||
|
||||
@@ -147,7 +151,11 @@ BOOTMAGIC_ENABLE = lite
|
||||
|
||||
ブートローダを起動するには、キーボードを接続する時にこのキーを押し続けます。たった1つのキーです。
|
||||
|
||||
!> ブートマジックライトを使用すると、EEPROM を**常にリセットします**。つまり保存された全ての設定は失われます。
|
||||
:::caution
|
||||
|
||||
ブートマジックライトを使用すると、EEPROM を**常にリセットします**。つまり保存された全ての設定は失われます。
|
||||
|
||||
:::
|
||||
|
||||
## 分割キーボード
|
||||
|
||||
|
||||
@@ -23,7 +23,11 @@ combo_t key_combos[COMBO_COUNT] = {COMBO(test_combo, KC_ESC)};
|
||||
|
||||
これは、A と B のキーを押した場合に、"Escape" を送信します。
|
||||
|
||||
!> このメソッドは[基本的なキーコード](ja/keycodes_basic.md)のみをサポートします。詳細な制御については例を見てください。
|
||||
:::caution
|
||||
|
||||
このメソッドは[基本的なキーコード](ja/keycodes_basic.md)のみをサポートします。詳細な制御については例を見てください。
|
||||
|
||||
:::
|
||||
|
||||
## 例
|
||||
|
||||
|
||||
@@ -29,7 +29,11 @@ QMK はその場で作られた一時的なマクロをサポートします。
|
||||
|
||||
マクロの一部としてマクロを再生することができます。マクロ 1 を記録中にマクロ 2 を再生、またはその逆も問題ありません。ただし、再帰的なマクロ、つまりマクロ 1 を再生するマクロ 1 は作成しないでください。もしそうしてキーボードが反応しなくなった場合は、キーボードを取り外し再び接続します。これを完全に無効にするには、`config.h` ファイルで `DYNAMIC_MACRO_NO_NESTING` を定義します。
|
||||
|
||||
?> 動的マクロの内部の詳細については、`process_dynamic_macro.h` および `process_dynamic_macro.c` ファイルのコメントを読んでください。
|
||||
:::tip
|
||||
|
||||
動的マクロの内部の詳細については、`process_dynamic_macro.h` および `process_dynamic_macro.c` ファイルのコメントを読んでください。
|
||||
|
||||
:::
|
||||
|
||||
## カスタマイズ
|
||||
|
||||
|
||||
@@ -87,7 +87,11 @@ QMK を使い始めたばかりの場合は、全てを単純にしたいでし
|
||||
| `default_layer_state_set_kb(layer_state_t state)` | キーボードレベルのデフォルトレイヤー関数のためのコールバック。キーボードの初期化時に呼ばれます。 |
|
||||
| `default_layer_state_set_user(layer_state_t state)` | ユーザレベルのデフォルトレイヤー関数のためのコールバック。キーボードの初期化時に呼ばれます。 |
|
||||
|
||||
?> これらのコールバックを使うための追加の情報については、[レイヤー変換コード](ja/custom_quantum_functions.md#layer-change-code)のドキュメントを調べてください。
|
||||
:::tip
|
||||
|
||||
これらのコールバックを使うための追加の情報については、[レイヤー変換コード](ja/custom_quantum_functions.md#layer-change-code)のドキュメントを調べてください。
|
||||
|
||||
:::
|
||||
|
||||
次の関数やマクロを使って、特定のレイヤーの状態を確認することもできます。
|
||||
|
||||
|
||||
@@ -18,7 +18,11 @@ QMK は HID 仕様で定義された5つの LED の読み取りメソッドを
|
||||
* `bool led_update_kb(led_t led_state)` あるいは `_user(led_t led_state)` を実装する、または
|
||||
* `led_t host_keyboard_led_state()` を呼び出す
|
||||
|
||||
!> `host_keyboard_led_state()` は `led_update_user()` が呼ばれる前に新しい値を既に反映している場合があります。
|
||||
:::caution
|
||||
|
||||
`host_keyboard_led_state()` は `led_update_user()` が呼ばれる前に新しい値を既に反映している場合があります。
|
||||
|
||||
:::
|
||||
|
||||
LED の状態を `uint8_t` として提供する2つの非推奨の関数があります:
|
||||
|
||||
@@ -53,7 +57,11 @@ LED の状態を `uint8_t` として提供する2つの非推奨の関数があ
|
||||
- LED がオンあるいはオフになった時に音楽を再生する。
|
||||
- `_kb` 関数を実行したいので、`true` を返します。これはデフォルトの LED の挙動に追加されます。
|
||||
|
||||
?> `led_set_*` 関数は `bool` の代わりに `void` を返すため、キーボードの LED 制御を上書きすることができません。従って、代わりに `led_update_*` を使うことをお勧めします。
|
||||
:::tip
|
||||
|
||||
`led_set_*` 関数は `bool` の代わりに `void` を返すため、キーボードの LED 制御を上書きすることができません。従って、代わりに `led_update_*` を使うことをお勧めします。
|
||||
|
||||
:::
|
||||
|
||||
### `led_update_kb()` の実装例
|
||||
|
||||
|
||||
@@ -7,7 +7,11 @@
|
||||
|
||||
マクロにより、1つのキーを押すだけで複数のキーストロークを送信することができます。QMK にはマクロを定義し使う方法が幾つかあります。これらはなんでもすることができます: よく使うフレーズの入力、コピーペースト、反復的なゲームの動き、あるいはコードを書くことさえ手助けします。
|
||||
|
||||
!> **セキュリティの注意**: マクロを使って、パスワード、クレジットカード番号、その他の機密情報のいずれも送信することが可能ですが、それは非常に悪い考えです。あなたのキーボードを手に入れた人は誰でもテキストエディタを開いてその情報にアクセスすることができます。
|
||||
:::caution
|
||||
|
||||
**セキュリティの注意**: マクロを使って、パスワード、クレジットカード番号、その他の機密情報のいずれも送信することが可能ですが、それは非常に悪い考えです。あなたのキーボードを手に入れた人は誰でもテキストエディタを開いてその情報にアクセスすることができます。
|
||||
|
||||
:::
|
||||
|
||||
## `SEND_STRING()` と `process_record_user`
|
||||
|
||||
@@ -214,7 +218,11 @@ SEND_STRING(".."SS_TAP(X_END));
|
||||
|
||||
マクロの生成に役立つ関数が幾つかあります。マクロの中にかなり高度なコードを書くことができますが、機能が複雑になりすぎる場合は、代わりにカスタムキーコードを定義することをお勧めします。マクロはシンプルにしなければなりません。
|
||||
|
||||
?> 追加の機能として、[便利な関数](ja/ref_functions.md) の中で説明される関数を使うこともできます。例えば `reset_keyboard()` によりマクロの一部としてキーボードをリセットすることができます。
|
||||
:::tip
|
||||
|
||||
追加の機能として、[便利な関数](ja/ref_functions.md) の中で説明される関数を使うこともできます。例えば `reset_keyboard()` によりマクロの一部としてキーボードをリセットすることができます。
|
||||
|
||||
:::
|
||||
|
||||
### `record->event.pressed`
|
||||
|
||||
|
||||
@@ -13,7 +13,11 @@ QMK ファームウェアには、任意のキーボードで使用可能な一
|
||||
|
||||
このため、主に Let's Split とその他のキーボードで使われる一般的な実装について説明します。
|
||||
|
||||
!> ARM はまだ完全には分割キーボードをサポートしておらず、様々な制限があります。進捗はしていますが、機能の100%にはまだ達していません。
|
||||
:::caution
|
||||
|
||||
ARM はまだ完全には分割キーボードをサポートしておらず、様々な制限があります。進捗はしていますが、機能の100%にはまだ達していません。
|
||||
|
||||
:::
|
||||
|
||||
|
||||
## 互換性の概要
|
||||
@@ -49,13 +53,21 @@ QMK ファームウェアには、任意のキーボードで使用可能な一
|
||||
|
||||
ただし、USB ケーブル、SATA ケーブル、そして単に4本の電線でもコントローラ間の通信に使用できることがわかっています。
|
||||
|
||||
!> コントローラ間の通信に USB ケーブルを使っても問題ありませんが、コネクタは通常の USB 接続と間違えられるかもしれず、配線方法によってはキーボードが短絡する可能性があります。このため、分割キーボードの接続のためにはお勧めできません。
|
||||
:::caution
|
||||
|
||||
コントローラ間の通信に USB ケーブルを使っても問題ありませんが、コネクタは通常の USB 接続と間違えられるかもしれず、配線方法によってはキーボードが短絡する可能性があります。このため、分割キーボードの接続のためにはお勧めできません。
|
||||
|
||||
:::
|
||||
|
||||
### シリアル配線
|
||||
|
||||
2つの Pro Micro 間で GND、Vcc、D0/D1/D2/D3 (別名 PD0/PD1/PD2/PD3) を TRS/TRRS ケーブルの3本のワイヤで接続します。
|
||||
|
||||
?> ここで使われるピンは実際には以下の `SOFT_SERIAL_PIN` によって設定されることに注意してください。
|
||||
:::tip
|
||||
|
||||
ここで使われるピンは実際には以下の `SOFT_SERIAL_PIN` によって設定されることに注意してください。
|
||||
|
||||
:::
|
||||
|
||||
<img alt="sk-pd0-connection-mono" src="https://user-images.githubusercontent.com/2170248/92296488-28e9ad80-ef70-11ea-98be-c40cb48a0319.JPG" width="48%"/>
|
||||
<img alt="sk-pd2-connection-mono" src="https://user-images.githubusercontent.com/2170248/92296490-2d15cb00-ef70-11ea-801f-5ace313013e6.JPG" width="48%"/>
|
||||
@@ -222,7 +234,11 @@ SPLIT_TRANSPORT = custom
|
||||
|
||||
これは各コントローラに直接接続されている LED の数を設定します。最初の数は左側、2番目の数は右側です。
|
||||
|
||||
?> この設定は `RGBLIGHT_SPLIT` が有効になっていることを意味し、有効になっていない場合は強制的に有効にします。
|
||||
:::tip
|
||||
|
||||
この設定は `RGBLIGHT_SPLIT` が有効になっていることを意味し、有効になっていない場合は強制的に有効にします。
|
||||
|
||||
:::
|
||||
|
||||
|
||||
```c
|
||||
@@ -230,7 +246,11 @@ SPLIT_TRANSPORT = custom
|
||||
```
|
||||
このオプションは、スタートアップの挙動を変更して、マスタ/スレーブの決定時にアクティブな USB 接続を検出します。このオプションがタイムアウトになった場合、その片側はスレーブと見なされます。これは ARM のデフォルトの挙動で、AVR Teensy ボードに必要です (ハードウェアの制限のため)。
|
||||
|
||||
?> この設定はバッテリパックを使ったデモの機能を停止します。
|
||||
:::tip
|
||||
|
||||
この設定はバッテリパックを使ったデモの機能を停止します。
|
||||
|
||||
:::
|
||||
|
||||
```c
|
||||
#define SPLIT_USB_TIMEOUT 2000
|
||||
|
||||
@@ -37,7 +37,11 @@
|
||||
|
||||
最初のオプションで、1つのキーに2つの役割を持たせる大抵のケースには十分です。例えば、`ACTION_TAP_DANCE_DOUBLE(KC_SPC, KC_ENT)` は、1回タップすると `Space` を送信し、2回タップすると `Enter` を送信します。
|
||||
|
||||
!> ここでは [基本的なキーコード](ja/keycodes_basic.md) だけがサポートされていることを覚えておいてください。カスタムキーコードはサポートされていません。
|
||||
:::caution
|
||||
|
||||
ここでは [基本的なキーコード](ja/keycodes_basic.md) だけがサポートされていることを覚えておいてください。カスタムキーコードはサポートされていません。
|
||||
|
||||
:::
|
||||
|
||||
最初のオプションに似ていますが、2番目のオプションは単純なレイヤー切替のケースに適しています。
|
||||
|
||||
|
||||
@@ -21,7 +21,7 @@ QMK は、Unicode 入力を有効にし、キーマップに Unicode 文字を
|
||||
|
||||
ほとんどのユーザには Basic Unicode で十分です。ただし、サポートされる文字の範囲が広い(絵文字、珍しい記号など)ことが必要な場合には、Unicode Map を使う必要があります。
|
||||
|
||||
<br>
|
||||
<br />
|
||||
|
||||
### 1.1. Basic Unicode :id=basic-unicode
|
||||
|
||||
@@ -35,7 +35,7 @@ UNICODE_ENABLE = yes
|
||||
|
||||
次に、`UC(c)` キーコードをキーマップに追加します。ここで、_c_ は目的の文字のコードポイントです (できれば16進数で最大4桁の長さが望ましいです)。例えば、`UC(0x40B)` は [Ћ](https://unicode-table.com/en/040B/) を出力し、`UC(0x30C4)` は [ツ](https://unicode-table.com/en/30C4) を出力します。
|
||||
|
||||
<br>
|
||||
<br />
|
||||
|
||||
### 1.2. Unicode Map :id=unicode-map
|
||||
|
||||
@@ -73,7 +73,7 @@ const uint32_t PROGMEM unicode_map[] = {
|
||||
|
||||
キーコードのサイズの制約により、_i_ と _j_ はそれぞれ `unicode_map` の最初の128文字のうち1つだけを参照できます。別の言い方をすると、0 ≤ _i_ ≤ 127 かつ 0 ≤ _j_ ≤ 127 です。これはほとんどのユースケースで十分ですが、インデックス計算をカスタマイズしたい場合は、[`unicodemap_index()`](https://github.com/qmk/qmk_firmware/blob/71f640d47ee12c862c798e1f56392853c7b1c1a8/quantum/process_keycode/process_unicodemap.c#L36) 関数をオーバーライドすることができます。これにより、例えば Shift/Caps の代わりに Ctrl をチェックすることもできます。
|
||||
|
||||
<br>
|
||||
<br />
|
||||
|
||||
### 1.3. UCIS :id=ucis
|
||||
|
||||
@@ -122,9 +122,17 @@ QMK での Unicode の入力は、マクロのように、OS への一連の文
|
||||
有効にするには、_システム環境設定 > キーボード > 入力ソース_ に移動し、(_その他_ の下の) _Unicode 16進数入力_ をリストに追加し、次にメニューバーの入力ドロップダウンからそれをアクティブにします。
|
||||
デフォルトでは、このモードは Unicode 入力のために左 Option キー (`KC_LALT`) を使いますが、これは他のキーで [`UNICODE_KEY_MAC`](#input-key-configuration) を定義することで変更できます。
|
||||
|
||||
!> _Unicode 16進数入力_ 入力ソースの使用は、Option + 左矢印および Option + 右矢印 のような、幾つかの Option ベースのショートカットを無効にするかもしれません。
|
||||
:::caution
|
||||
|
||||
!> `UC_OSX` は `UC_MAC` の非推奨のエイリアスで、QMK の将来のバージョンで削除されます。全ての新しいキーマップは、`UC_MAC` を使うべきです。
|
||||
_Unicode 16進数入力_ 入力ソースの使用は、Option + 左矢印および Option + 右矢印 のような、幾つかの Option ベースのショートカットを無効にするかもしれません。
|
||||
|
||||
:::
|
||||
|
||||
:::caution
|
||||
|
||||
`UC_OSX` は `UC_MAC` の非推奨のエイリアスで、QMK の将来のバージョンで削除されます。全ての新しいキーマップは、`UC_MAC` を使うべきです。
|
||||
|
||||
:::
|
||||
|
||||
* **`UC_LNX`**: Linux の組み込み IBus Unicode 入力。`0x10FFFF` までのコードポイント(全ての利用可能なコードポイント)をサポートします。
|
||||
|
||||
@@ -178,7 +186,11 @@ QMK での Unicode の入力は、マクロのように、OS への一連の文
|
||||
|
||||
コード内で `set_unicode_input_mode(x)` を呼び出すことで、入力モードを切り替えることもできます。ここで、_x_ は上記の入力モード定数のいずれか (例えば、`UC_LNX`) です。
|
||||
|
||||
?> `matrix_init_user()` または同様の関数の中で `set_unicode_input_mode()` を呼び出すよりも、`UNICODE_SELECTED_MODES` を使うほうが望ましいです。Unicode システムとの統合性が高く、EEPROM への不要な書き込みを回避できるという利点があるからです。
|
||||
:::tip
|
||||
|
||||
`matrix_init_user()` または同様の関数の中で `set_unicode_input_mode()` を呼び出すよりも、`UNICODE_SELECTED_MODES` を使うほうが望ましいです。Unicode システムとの統合性が高く、EEPROM への不要な書き込みを回避できるという利点があるからです。
|
||||
|
||||
:::
|
||||
|
||||
#### オーディオフィードバック
|
||||
|
||||
|
||||
@@ -27,7 +27,11 @@
|
||||
|
||||
は、`/users/jack/rules.mk` に加えて、パスに `/users/jack/` フォルダを含めます。
|
||||
|
||||
!> この `name` は必要に応じて[上書き](#override-default-userspace)することができます。
|
||||
:::caution
|
||||
|
||||
この `name` は必要に応じて[上書き](#override-default-userspace)することができます。
|
||||
|
||||
:::
|
||||
|
||||
## `Rules.mk`
|
||||
|
||||
|
||||
@@ -18,7 +18,11 @@ ps2avr(GB) キーボードは ATmega32A マイクロコントローラを使い
|
||||
|
||||
## bootloadHID の書き込みターゲット
|
||||
|
||||
?> [こちら](ja/newbs_getting_started.md)で詳しく説明されている QMK インストールスクリプトを使うと、必要な bootloadHID ツールが自動的にインストールされます。
|
||||
:::tip
|
||||
|
||||
[こちら](ja/newbs_getting_started.md)で詳しく説明されている QMK インストールスクリプトを使うと、必要な bootloadHID ツールが自動的にインストールされます。
|
||||
|
||||
:::
|
||||
|
||||
コマンドライン経由で書き込むには、以下のコマンドを実行してターゲット `:bootloadHID` を使います:
|
||||
|
||||
|
||||
@@ -7,7 +7,11 @@
|
||||
|
||||
GitHub は慣れていない人には少し注意が必要です - このガイドは、QMK におけるフォーク、クローン、プルリクエストのサブミットの各ステップについて説明します。
|
||||
|
||||
?> このガイドでは、あなたがコマンドラインでの実行にある程度慣れており、システムに git がインストールされていることを前提にしています。
|
||||
:::tip
|
||||
|
||||
このガイドでは、あなたがコマンドラインでの実行にある程度慣れており、システムに git がインストールされていることを前提にしています。
|
||||
|
||||
:::
|
||||
|
||||
[QMK GitHub ページ](https://github.com/qmk/qmk_firmware)を開くと、右上に "Fork" というボタンが見えます:
|
||||
|
||||
|
||||
@@ -85,7 +85,11 @@ Your Name: [John Smith]
|
||||
#define PRODUCT my_awesome_keyboard
|
||||
```
|
||||
|
||||
?> Windows や macOS では、`MANUFACTURER` と `PRODUCT` が USBデバイスのリストに表示されます。Linux 上の `lsusb` では、代わりに [USB ID Repository](http://www.linux-usb.org/usb-ids.html) によって維持されているリストの値を優先します。デフォルトでは、リストに `VENDOR_ID` / `PRODUCT_ID` を含まない場合にのみ、`MANUFACTURER` と `PRODUCT` を使います。`sudo lsusb -v` を使用するとデバイスから示された値を表示します。また、接続したときのカーネルログにも表示されます。
|
||||
:::tip
|
||||
|
||||
Windows や macOS では、`MANUFACTURER` と `PRODUCT` が USBデバイスのリストに表示されます。Linux 上の `lsusb` では、代わりに [USB ID Repository](http://www.linux-usb.org/usb-ids.html) によって維持されているリストの値を優先します。デフォルトでは、リストに `VENDOR_ID` / `PRODUCT_ID` を含まない場合にのみ、`MANUFACTURER` と `PRODUCT` を使います。`sudo lsusb -v` を使用するとデバイスから示された値を表示します。また、接続したときのカーネルログにも表示されます。
|
||||
|
||||
:::
|
||||
|
||||
### キーボードマトリックスの設定
|
||||
|
||||
|
||||
@@ -135,7 +135,11 @@ Clueboard は、サブフォルダをまとめるためとキーボードのリ
|
||||
#endif
|
||||
```
|
||||
|
||||
?> 上記の例のように `post_config.h` でオプションを定義する場合、キーボードやユーザレベルの `config.h` で同じオプションを定義してはいけません。
|
||||
:::tip
|
||||
|
||||
上記の例のように `post_config.h` でオプションを定義する場合、キーボードやユーザレベルの `config.h` で同じオプションを定義してはいけません。
|
||||
|
||||
:::
|
||||
|
||||
### `rules.mk`
|
||||
|
||||
@@ -154,7 +158,11 @@ Clueboard は、サブフォルダをまとめるためとキーボードのリ
|
||||
|
||||
`rules.mk` ファイルに書かれた多くの設定は `common_features.mk` によって解釈され、必要なソースファイルやコンパイラのオプションが設定されます。
|
||||
|
||||
?> 詳しくは `build_keyboard.mk` と `common_features.mk` を見てください。
|
||||
:::tip
|
||||
|
||||
詳しくは `build_keyboard.mk` と `common_features.mk` を見てください。
|
||||
|
||||
:::
|
||||
|
||||
### `<keyboard_name.c>`
|
||||
|
||||
|
||||
@@ -11,7 +11,11 @@ ISP 書き込み(ICSP 書き込みと呼ぶ場合もあります)とは、マイ
|
||||
|
||||
QMK の ISP 書き込みの主な用途は、AVRベースのコントローラ（Pro Micro、または V-USB チップ）のブートローダの書き込みまたは交換です。
|
||||
|
||||
?> これは Pro Micro や他の ATmega コントローラなどの AVR ベースのボードをプログラミングするためだけのものです。 Proton C などの Arm コントローラには使用できません。
|
||||
:::tip
|
||||
|
||||
これは Pro Micro や他の ATmega コントローラなどの AVR ベースのボードをプログラミングするためだけのものです。 Proton C などの Arm コントローラには使用できません。
|
||||
|
||||
:::
|
||||
|
||||
## 破損したブートローダーの取り扱い
|
||||
|
||||
@@ -112,7 +116,11 @@ QMK ツールボックスは、このほとんど（すべて）に使用する
|
||||
Teensy VCC <-> Keyboard VCC
|
||||
Teensy GND <-> Keyboard GND
|
||||
|
||||
!> Teensy の B0 ピンはキーボードのコントローラの RESET/RST ピンと配線されています。 Teensy の RESET ピンをキーボードの RESET に配線しないでください。
|
||||
:::caution
|
||||
|
||||
Teensy の B0 ピンはキーボードのコントローラの RESET/RST ピンと配線されています。 Teensy の RESET ピンをキーボードの RESET に配線しないでください。
|
||||
|
||||
:::
|
||||
|
||||
### Pro Micro
|
||||
|
||||
@@ -123,7 +131,11 @@ QMK ツールボックスは、このほとんど（すべて）に使用する
|
||||
Pro Micro VCC <-> Keyboard VCC
|
||||
Pro Micro GND <-> Keyboard GND
|
||||
|
||||
!> Pro Micro の 10/B6 ピンはキーボードのコントローラの RESET/RST ピンに配線されています。 Pro Micro の RESET ピンをキーボードの RESET に配線 ***しないでください***。
|
||||
:::caution
|
||||
|
||||
Pro Micro の 10/B6 ピンはキーボードのコントローラの RESET/RST ピンに配線されています。 Pro Micro の RESET ピンをキーボードの RESET に配線 ***しないでください***。
|
||||
|
||||
:::
|
||||
|
||||
## キーボードへの書き込み
|
||||
|
||||
@@ -163,7 +175,11 @@ ISP プログラマをセットアップして、キーボードに接続した
|
||||
3. ブートローダの内容全体を新しい行にコピーして(行間に空行を入れないように)、元のファイルの最後に貼り付けてください。
|
||||
4. これを新しいファイルとして `<keyboard>_<keymap>_production.hex` という名前で保存します。
|
||||
|
||||
?> ここでは他のブートローダも同じように使うことができますが、__ブートローダが必要で__、そうしないとまた ISP を使ってキーボードに新しいファームウェアを書き込まなければならなくなります。
|
||||
:::tip
|
||||
|
||||
ここでは他のブートローダも同じように使うことができますが、__ブートローダが必要で__、そうしないとまた ISP を使ってキーボードに新しいファームウェアを書き込まなければならなくなります。
|
||||
|
||||
:::
|
||||
|
||||
#### QMK DFU ブートローダとプロダクションイメージの作成
|
||||
|
||||
@@ -180,7 +196,11 @@ QMK DFU ブートローダは `atmega32u4` コントローラ (AVR ベースの
|
||||
ブートローダかプロダクションファームウェアファイルのどちらかを書き込むことができます。
|
||||
プロダクションファームウェアファイルの方が、より多くのデータを書き込むので、書き込みに時間がかかります。
|
||||
|
||||
?> 注意：同じブートローダを使用しつづけるべきです。すでに DFU を使用している場合は、QMK DFU に切り替えても問題ありません。しかし、例えば Pro Micro に QMK DFU を書き込むには、追加の手順が必要になります。
|
||||
:::tip
|
||||
|
||||
注意：同じブートローダを使用しつづけるべきです。すでに DFU を使用している場合は、QMK DFU に切り替えても問題ありません。しかし、例えば Pro Micro に QMK DFU を書き込むには、追加の手順が必要になります。
|
||||
|
||||
:::
|
||||
|
||||
## ブートローダ/プロダクションファイルの書き込み
|
||||
|
||||
@@ -253,7 +273,11 @@ SparkFun PocketAVR Programmer や、他の USB Tiny ベースの ISP プログ
|
||||
Pro Micro に QMK DFU を書き込むなど、ブートローダを切り替える場合は、ブートローダの hex ファイルの書き込みに加えて、ヒューズを変更する必要があります。
|
||||
これは、`caterina` (Pro Micro ブートローダ) と `dfu` では起動ルーチンの扱いが異なり、その動作はヒューズによって制御されるからです。
|
||||
|
||||
!> これは、ヒューズを変更することは、永久にあなたのコントローラをレンガ化(訳注:日本では文鎮化と呼ぶことが多い、コントローラがまったく無反応になる状態)することができる方法の1つであるため、それは非常に注意が必要な1つの領域です。
|
||||
:::caution
|
||||
|
||||
これは、ヒューズを変更することは、永久にあなたのコントローラをレンガ化(訳注:日本では文鎮化と呼ぶことが多い、コントローラがまったく無反応になる状態)することができる方法の1つであるため、それは非常に注意が必要な1つの領域です。
|
||||
|
||||
:::
|
||||
|
||||
以下は、`atmega32u4`の 5V 16MHz 版（5V Pro Micro など）を想定しています。
|
||||
|
||||
|
||||
+10
-2
@@ -13,8 +13,16 @@
|
||||
|
||||
[基本的なキーコード](ja/keycodes_basic.md) も見てください。
|
||||
|
||||
?> 訳注: 以下の説明は、OS のキーボード配列の設定が「US」の場合のものです。OS のキーボード配列の設定が「JIS」の場合、一部のキーは下の表と異なる文字が入力されます。例えば、`KC_LBRC` は、OS のキーボード配列の設定が US であれば「`[` または `{`」が入力されますが、JIS の場合「`@` または <code>`</code>」が入力されます。
|
||||
?> これは、OS がキーボードから送信されたキーコードを解釈する際に、キーボード配列の設定によって対応する文字を変えるためです。もし、OS のキーボード配列の設定を JIS にする場合、`#include "keymap_jp.h"` を `keymap.c` に追加すると`JP_AT` のような JIS キーボードのキーキャップに対応したキーを指定できます。
|
||||
:::caution
|
||||
|
||||
訳注: 以下の説明は、OS のキーボード配列の設定が「US」の場合のものです。OS のキーボード配列の設定が「JIS」の場合、一部のキーは下の表と異なる文字が入力されます。例えば、`KC_LBRC` は、OS のキーボード配列の設定が US であれば「`[` または `{`」が入力されますが、JIS の場合「`@` または <code>`</code>」が入力されます。
|
||||
:::tip
|
||||
|
||||
:::
|
||||
|
||||
これは、OS がキーボードから送信されたキーコードを解釈する際に、キーボード配列の設定によって対応する文字を変えるためです。もし、OS のキーボード配列の設定を JIS にする場合、`#include "keymap_jp.h"` を `keymap.c` に追加すると`JP_AT` のような JIS キーボードのキーキャップに対応したキーを指定できます。
|
||||
|
||||
:::
|
||||
|
||||
|キー |エイリアス |説明 |Windows |macOS |Linux<sup>1</sup>|
|
||||
|-----------------------|------------------------------|-----------------------------------------|-------------|-------------|-----------------|
|
||||
|
||||
@@ -196,7 +196,11 @@
|
||||
|
||||
これらのキーコードは、HID Keyboard/Keypad usage ページにはありません。`SYSTEM_` キーコードは、Generic Desktop ページで見つかります。また、その他は Consumer ページにあります。
|
||||
|
||||
?> これらのキーコードのいくつかは、OS によって異なる動作をする可能性があります。例として、macOS では `KC_MEDIA_FAST_FORWARD`、`KC_MEDIA_REWIND`、`KC_MEDIA_NEXT_TRACK`、`KC_MEDIA_PREV_TRACK` は、押している間は現在の曲の中でスキップしますが、タップした時は曲全体をスキップします。
|
||||
:::tip
|
||||
|
||||
これらのキーコードのいくつかは、OS によって異なる動作をする可能性があります。例として、macOS では `KC_MEDIA_FAST_FORWARD`、`KC_MEDIA_REWIND`、`KC_MEDIA_NEXT_TRACK`、`KC_MEDIA_PREV_TRACK` は、押している間は現在の曲の中でスキップしますが、タップした時は曲全体をスキップします。
|
||||
|
||||
:::
|
||||
|
||||
|キー |エイリアス |説明 |
|
||||
|-----------------------|-----------|----------------------|
|
||||
|
||||
+5
-1
@@ -19,9 +19,13 @@ QMK は、簡単なことは簡単に、そして、難しいことを可能な
|
||||
QMK は[多くの趣味のキーボード](https://qmk.fm/keyboards/)をサポートしています。
|
||||
現在使用しているキーボードが QMK を実行できない場合、QMK を実行できるキーボードの選択肢はたくさんあります。
|
||||
|
||||
?> **このガイドは私のためにあるのでしょうか？**<br>
|
||||
:::caution
|
||||
|
||||
**このガイドは私のためにあるのでしょうか？**<br />
|
||||
もし、プログラミングの考え方に抵抗があるのであれば、代わりに[私たちのオンライン GUI](ja/newbs_building_firmware_configurator.md) を見てみてください。
|
||||
|
||||
:::
|
||||
|
||||
## 概要
|
||||
|
||||
このガイドは、ソースコードを使ってキーボードのファームウェアを構築したいと考えている人に適しています。 もしあなたがすでにプログラマーであれば、このプロセスはとても身近で簡単に理解できるでしょう。このガイドには3つの主要なセクションがあります:
|
||||
|
||||
@@ -39,7 +39,11 @@
|
||||
その下には、`LAYOUT` を含む行があり、これらの行はレイヤーの開始を表わしています。
|
||||
その行の下には、そのレイヤーを構成するキーのリストがあります。
|
||||
|
||||
!> キーマップファイルを編集するときは、カンマを追加したり削除したりしないように注意してください。そうするとファームウェアのコンパイルができなくなり、余分であったり欠落していたりするカンマがどこにあるのかを容易に把握できない場合があります。
|
||||
:::caution
|
||||
|
||||
キーマップファイルを編集するときは、カンマを追加したり削除したりしないように注意してください。そうするとファームウェアのコンパイルができなくなり、余分であったり欠落していたりするカンマがどこにあるのかを容易に把握できない場合があります。
|
||||
|
||||
:::
|
||||
|
||||
## 好みに合わせてレイアウトをカスタマイズ
|
||||
|
||||
@@ -53,7 +57,11 @@ QMK にはたくさんの機能があり、完全なリストは左側のサイ
|
||||
* [グレイブ エスケープ](ja/feature_grave_esc.md)
|
||||
* [マウスキー](ja/feature_mouse_keys.md)
|
||||
|
||||
?> キーマップがどのように機能するかを感じながら、各変更を小さくしてください。大きな変更は、発生する問題のデバッグを困難にします。
|
||||
:::tip
|
||||
|
||||
キーマップがどのように機能するかを感じながら、各変更を小さくしてください。大きな変更は、発生する問題のデバッグを困難にします。
|
||||
|
||||
:::
|
||||
|
||||
## ファームウェアをビルドする :id=build-your-firmware
|
||||
|
||||
|
||||
@@ -15,6 +15,10 @@
|
||||
|
||||
QMK Configurator は Chrome/Firefox で最適に動作します。
|
||||
|
||||
!> **注意: Keyboard Layout Editor (KLE) や kbfirmware などの他のツールのファイルは、QMK Configurator と互換性がありません。それらをロードしたり、インポートしたりしないでください。QMK Configurator は異なるツールです。**
|
||||
:::caution
|
||||
|
||||
**注意: Keyboard Layout Editor (KLE) や kbfirmware などの他のツールのファイルは、QMK Configurator と互換性がありません。それらをロードしたり、インポートしたりしないでください。QMK Configurator は異なるツールです。**
|
||||
|
||||
:::
|
||||
|
||||
[QMK Configurator: ステップ・バイ・ステップ](ja/configurator_step_by_step.md)を参照してください。
|
||||
|
||||
@@ -18,7 +18,11 @@
|
||||
* [Toolbox (オプション)](https://github.com/qmk/qmk_toolbox)
|
||||
* Windows と macOS で使える GUI を備えたプログラムで、カスタムキーボードのプログラミングとデバッグの両方ができます。
|
||||
|
||||
?> もし、Linux か Unix のコマンドを使ったことがない場合、こちらで基本的な概念や各種コマンドを学んでください。[これらの教材](ja/newbs_learn_more_resources.md#command-line-resources)で QMK を使うのに必要なことを学ぶことができます。
|
||||
:::tip
|
||||
|
||||
もし、Linux か Unix のコマンドを使ったことがない場合、こちらで基本的な概念や各種コマンドを学んでください。[これらの教材](ja/newbs_learn_more_resources.md#command-line-resources)で QMK を使うのに必要なことを学ぶことができます。
|
||||
|
||||
:::
|
||||
|
||||
## 2. ビルド環境を準備する :id=set-up-your-environment
|
||||
|
||||
@@ -39,7 +43,11 @@ QMK は、MSYS2、CLI、および必要な全ての依存関係のバンドル
|
||||
<details>
|
||||
<summary>手動インストール</summary>
|
||||
|
||||
?> `QMK MSYS` を使う場合、次のステップは無視してください。
|
||||
:::tip
|
||||
|
||||
`QMK MSYS` を使う場合、次のステップは無視してください。
|
||||
|
||||
:::
|
||||
|
||||
#### 前提条件
|
||||
|
||||
@@ -47,7 +55,11 @@ MSYS2 と Git と Python をインストールする必要があります。http
|
||||
|
||||
MSYS2 をインストールしたら、開いている MSYS の全ターミナル画面を閉じて、新しい MinGW 64-bit ターミナル画面を開きます。
|
||||
|
||||
!> **注意:** MinGW 64-bit ターミナルは、インストールが完了した時に開く MSYS ターミナルと*同じではありません*。プロンプトには、「MSYS」ではなく、紫色のテキストで「MINGW64」と表示されます。違いについての詳細は[このページ](https://www.msys2.org/wiki/MSYS2-introduction/#subsystems)を参照してください。
|
||||
:::caution
|
||||
|
||||
**注意:** MinGW 64-bit ターミナルは、インストールが完了した時に開く MSYS ターミナルと*同じではありません*。プロンプトには、「MSYS」ではなく、紫色のテキストで「MINGW64」と表示されます。違いについての詳細は[このページ](https://www.msys2.org/wiki/MSYS2-introduction/#subsystems)を参照してください。
|
||||
|
||||
:::
|
||||
|
||||
それから、次のように実行します:
|
||||
|
||||
@@ -77,7 +89,11 @@ Homebrew のインストールが必要です。https://brew.sh の手順に従
|
||||
|
||||
### ** Linux/WSL **
|
||||
|
||||
?> **WSL ユーザーへの注意**: デフォルトでは、インストールプロセスは QMK リポジトリを WSL ホームディレクトリに clone しますが、手動で clone した場合、Windows ファイルシステムではなく、WSL インスタンス内にある(つまり `/mnt` 内にない)ことを確認してください。これは、現在アクセスが[非常に遅い](https://github.com/microsoft/WSL/issues/4197)ためです。
|
||||
:::tip
|
||||
|
||||
**WSL ユーザーへの注意**: デフォルトでは、インストールプロセスは QMK リポジトリを WSL ホームディレクトリに clone しますが、手動で clone した場合、Windows ファイルシステムではなく、WSL インスタンス内にある(つまり `/mnt` 内にない)ことを確認してください。これは、現在アクセスが[非常に遅い](https://github.com/microsoft/WSL/issues/4197)ためです。
|
||||
|
||||
:::
|
||||
|
||||
#### 前提条件
|
||||
|
||||
@@ -165,9 +181,17 @@ QMK のインストール後に、このコマンドで設定できます:
|
||||
|
||||
<!-- tabs:end -->
|
||||
|
||||
?> qmk ホームフォルダは、セットアップ時に `qmk setup -H <path>` を使って指定し、[cli 構成](ja/cli_configuration.md?id=single-key-example)と変数 `user.qmk_home` を使って変更できます。利用可能な全てのオプションについては、`qmk setup --help` を実行します。
|
||||
:::tip
|
||||
|
||||
?> 既に GitHub の使い方を知っている場合、[これらの手順に従うことをお勧めします](ja/getting_started_github.md)。そして `qmk setup <github_username>/qmk_firmware` を使って個人用の fork から clone します。この一文の意味が分からない場合、このメッセージは無視してかまいません。
|
||||
qmk ホームフォルダは、セットアップ時に `qmk setup -H <path>` を使って指定し、[cli 構成](ja/cli_configuration.md?id=single-key-example)と変数 `user.qmk_home` を使って変更できます。利用可能な全てのオプションについては、`qmk setup --help` を実行します。
|
||||
|
||||
:::
|
||||
|
||||
:::tip
|
||||
|
||||
既に GitHub の使い方を知っている場合、[これらの手順に従うことをお勧めします](ja/getting_started_github.md)。そして `qmk setup <github_username>/qmk_firmware` を使って個人用の fork から clone します。この一文の意味が分からない場合、このメッセージは無視してかまいません。
|
||||
|
||||
:::
|
||||
|
||||
## 4. ビルド環境の確認
|
||||
|
||||
|
||||
@@ -9,9 +9,13 @@
|
||||
ブランチでの作業の完了に時間がかかる場合、他の人が行った変更が、プルリクエストを開いたときにブランチに加えた変更と競合することがあります。
|
||||
これは *マージの競合* と呼ばれ、複数の人が同じファイルの同じ部分を編集すると発生します。
|
||||
|
||||
?> このドキュメントは [あなたのフォークの master ブランチ: 更新は頻繁に、コミットはしないこと](ja/newbs_git_using_your_master_branch.md) で詳述されている概念に基づいています。
|
||||
:::caution
|
||||
|
||||
このドキュメントは [あなたのフォークの master ブランチ: 更新は頻繁に、コミットはしないこと](ja/newbs_git_using_your_master_branch.md) で詳述されている概念に基づいています。
|
||||
その概念に慣れていない場合は、まずそれを読んでから、ここに戻ってください。
|
||||
|
||||
:::
|
||||
|
||||
## 変更のリベース
|
||||
|
||||
*リベース* は、コミット履歴のある時点で適用された変更を取得し、それらを元に戻し、次に同じ変更を別のポイントに適用する Git の方法です。
|
||||
|
||||
@@ -10,9 +10,13 @@
|
||||
(フォーク元の) QMK の `master` ブランチをあなたの `master` ブランチに `git pull` することもできますが、GitHub は、あなたのブランチが `qmk:master` より何コミットか先行していると通知します、この状態で QMK にプルリクエストを行う場合、問題が発生する可能性があります。
|
||||
(訳注：この通知は、GitHub のあなたのリポジトリの code ペインのブランチ選択メニューの下のあたりで `This branch is 3 commit ahead of qmk:master` という様な文面で表示されています。)
|
||||
|
||||
?> このドキュメントは [あなたのフォークの master ブランチ: 更新は頻繁に、コミットはしないこと](ja/newbs_git_using_your_master_branch.md) で詳述されている概念に基づいています。その概念に慣れていない場合は、まずそれを読んでから、ここに戻ってください。
|
||||
:::caution
|
||||
|
||||
このドキュメントは [あなたのフォークの master ブランチ: 更新は頻繁に、コミットはしないこと](ja/newbs_git_using_your_master_branch.md) で詳述されている概念に基づいています。その概念に慣れていない場合は、まずそれを読んでから、ここに戻ってください。
|
||||
(訳注：この文書で言う、「同期のとれていない git ブランチ」とは、master ブランチに関する、この「コミットしない」方針を逸脱して、QMK の master リポジトリに存在しないコミットがあなたのフォークの master ブランチに入っている状態を指します。)
|
||||
|
||||
:::
|
||||
|
||||
## あなた自身の `master` ブランチでの変更のバックアップ（オプション）
|
||||
|
||||
救えるものなら自分の行った変更を失いたくはないでしょう。
|
||||
@@ -82,7 +86,11 @@ GitHub 上のフォークを再同期するには、あなたのフォークに
|
||||
git push --force-with-lease
|
||||
```
|
||||
|
||||
!> 他のユーザーがコミットを投稿するフォークで `git push --force-with-lease` を**実行しないでください**。これをすると、かれらのコミットが消去されてしまいます。
|
||||
:::caution
|
||||
|
||||
他のユーザーがコミットを投稿するフォークで `git push --force-with-lease` を**実行しないでください**。これをすると、かれらのコミットが消去されてしまいます。
|
||||
|
||||
:::
|
||||
|
||||
これで、あなたの GitHub フォーク、あなたのローカルファイル、および QMK のリポジトリはすべて同じになりました。
|
||||
ここから、[ブランチを使って](ja/newbs_git_using_your_master_branch.md#making-changes)さらに必要な変更を加え、通常どおりそれらを投稿できます。
|
||||
|
||||
@@ -66,7 +66,11 @@ git push --set-upstream origin dev_branch
|
||||
この引数は最初のプッシュでのみ使用する必要があります。
|
||||
その後、残りの引数なしで `git push` または `git pull` を安全に使用できます。
|
||||
|
||||
?> `git push` では、`-set-upstream` の代わりに `-u` を使用できます、 `-u` は `--set-upstream` のエイリアスです。
|
||||
:::tip
|
||||
|
||||
`git push` では、`-set-upstream` の代わりに `-u` を使用できます、 `-u` は `--set-upstream` のエイリアスです。
|
||||
|
||||
:::
|
||||
|
||||
ブランチにはほぼ任意の名前を付けることができますが、あなたが行なう変更を表す名前を付けることをお勧めします。
|
||||
|
||||
@@ -92,7 +96,11 @@ git commit -m "My commit message."
|
||||
これには、`git commit` によって *コミット* される変更が含まれており、リポジトリへの変更が保存されます。
|
||||
変更内容が一目でわかるように、説明的なコミットメッセージを使用します。
|
||||
|
||||
?> 複数のファイルを変更した場合、`git add -- path/to/file1 path/to/file2 ...` を実行すれば、あなたの望むファイルを追加できます。
|
||||
:::tip
|
||||
|
||||
複数のファイルを変更した場合、`git add -- path/to/file1 path/to/file2 ...` を実行すれば、あなたの望むファイルを追加できます。
|
||||
|
||||
:::
|
||||
|
||||
## 変更を公開する
|
||||
|
||||
|
||||
@@ -23,7 +23,7 @@ _日本語のリソース情報を募集中です。_
|
||||
### 英語 :id=english-resources-cli
|
||||
|
||||
* [Good General Tutorial on Command Line](https://www.codecademy.com/learn/learn-the-command-line)
|
||||
* [Must Know Linux Commands](https://www.guru99.com/must-know-linux-commands.html)<br>
|
||||
* [Must Know Linux Commands](https://www.guru99.com/must-know-linux-commands.html)<br />
|
||||
* [Some Basic Unix Commands](https://www.tjhsst.edu/~dhyatt/superap/unixcmd.html)
|
||||
|
||||
### 日本語 :id=japanese-resources-cli
|
||||
|
||||
@@ -32,7 +32,11 @@
|
||||
|
||||
ワンショットモッドについては、設定するためには `set_oneshot_mods(MOD_BIT(KC_*))` を呼び出し、キャンセルするためには `clear_oneshot_mods()` を呼び出す必要があります。
|
||||
|
||||
!> リモートデスクトップ接続で OSM 変換に問題がある場合は、設定を開いて「ローカル リソース」タブに移動し、キーボードセクションでドロップダウンを「このコンピューター」に変更することで修正することができます。これにより問題が修正され、OSM がリモートデスクトップ上で適切に動作するようになります。
|
||||
:::caution
|
||||
|
||||
リモートデスクトップ接続で OSM 変換に問題がある場合は、設定を開いて「ローカル リソース」タブに移動し、キーボードセクションでドロップダウンを「このコンピューター」に変更することで修正することができます。これにより問題が修正され、OSM がリモートデスクトップ上で適切に動作するようになります。
|
||||
|
||||
:::
|
||||
|
||||
## コールバック
|
||||
|
||||
|
||||
+10
-2
@@ -59,7 +59,11 @@ VS Code のようなフル機能のエディタの使用は、プレーンテキ
|
||||
|
||||
このファイルを保存したら、VS Code が既に実行中の場合はリロードする必要があります。
|
||||
|
||||
?> また、`.vscode` フォルダ に `extensions.json` および `settings.json` ファイルがあるはずです。
|
||||
:::tip
|
||||
|
||||
また、`.vscode` フォルダ に `extensions.json` および `settings.json` ファイルがあるはずです。
|
||||
|
||||
:::
|
||||
|
||||
|
||||
次に、VSCode に統合ターミナルとして表示されるように、MSYS2 ウィンドウを設定します。これには多くの利点があります。ほとんどの場合で、エラー上で Ctrl + クリックするとこれらのファイルにジャンプできます。これによりデバッグがはるかに簡単になります。また、他のウィンドウへジャンプする必要が無いという点でも優れています。
|
||||
@@ -84,7 +88,11 @@ VS Code のようなフル機能のエディタの使用は、プレーンテキ
|
||||
|
||||
ここに既に設定がある場合は、最初と最後の波括弧の間に全てを追加し、既存の設定を新しく追加された設定とカンマで区切ります。
|
||||
|
||||
?> MSYS2 を別のフォルダにインストールした場合は、`terminal.integrated.shell.windows` のパスをシステムの正しいパスに変更する必要があります。
|
||||
:::tip
|
||||
|
||||
MSYS2 を別のフォルダにインストールした場合は、`terminal.integrated.shell.windows` のパスをシステムの正しいパスに変更する必要があります。
|
||||
|
||||
:::
|
||||
|
||||
4. Ctrl-<code>`</code> (Grave) を押して、ターミナルを起動するか、<kbd><kbd>表示</kbd> > <kbd>ターミナル</kbd></kbd> (コマンド `workbench.action.terminal.toggleTerminal`)に進みます。まだターミナルが開いていない場合は、新しいターミナルが開きます。
|
||||
|
||||
|
||||
@@ -88,7 +88,11 @@ layer_state_t layer_state_set_user(layer_state_t state) {
|
||||
```
|
||||
|
||||
|
||||
?> [quantum/audio/song_list.h](https://github.com/qmk/qmk_firmware/blob/master/quantum/audio/song_list.h) に使用できる多くの定義済みの曲があります。
|
||||
:::tip
|
||||
|
||||
[quantum/audio/song_list.h](https://github.com/qmk/qmk_firmware/blob/master/quantum/audio/song_list.h) に使用できる多くの定義済みの曲があります。
|
||||
|
||||
:::
|
||||
|
||||
## キーボードのリセット
|
||||
|
||||
@@ -106,7 +110,11 @@ EEPROM を消去するには、関数またはマクロから `eeconfig_init()`
|
||||
|
||||
ランダムな文字をホストコンピュータに送信する場合は、`tap_random_base64()` 関数を使うことができます。これは[疑似乱数的に](https://en.wikipedia.org/wiki/Pseudorandom_number_generator)0から63の数字を選択し、その選択に基づいてキー押下を送信します。(0–25 は `A`–`Z`、26–51 は `a`–`z`、52–61 は `0`–`9`、62 は `+`、63 は `/`)。
|
||||
|
||||
?> 言うまでもないですが、これはランダムに Base64 キーあるいはパスワードを生成する暗号的に安全な方法では _ありません_。
|
||||
:::tip
|
||||
|
||||
言うまでもないですが、これはランダムに Base64 キーあるいはパスワードを生成する暗号的に安全な方法では _ありません_。
|
||||
|
||||
:::
|
||||
|
||||
## ソフトウェアタイマー
|
||||
|
||||
|
||||
@@ -26,7 +26,11 @@ Configurator がキーボードをどのように理解するかを理解する
|
||||
|---------------|
|
||||
```
|
||||
|
||||
?> レイアウトマクロの詳細については、[QMK の理解: マトリックススキャン](ja/understanding_qmk.md?id=matrix-scanning) と [QMK の理解: マトリックスから物理レイアウトへのマップ](ja/understanding_qmk.md?id=matrix-to-physical-layout-map) を見てください。
|
||||
:::tip
|
||||
|
||||
レイアウトマクロの詳細については、[QMK の理解: マトリックススキャン](ja/understanding_qmk.md?id=matrix-scanning) と [QMK の理解: マトリックスから物理レイアウトへのマップ](ja/understanding_qmk.md?id=matrix-to-physical-layout-map) を見てください。
|
||||
|
||||
:::
|
||||
|
||||
Configurator の API はキーボードの `.h` ファイルを `qmk_firmware/keyboards/<keyboard>/<keyboard>.h` から読み取ります。numpad の場合、このファイルは `qmk_firmware/keyboards/numpad/numpad.h` です:
|
||||
|
||||
@@ -70,9 +74,17 @@ QMK は `KC_NO` を使って、スイッチマトリックス内のスイッチ
|
||||
}
|
||||
```
|
||||
|
||||
!> この使用方法はキーマップマクロと異なります。キーマップマクロはほとんど常に`KC_NO`については`XXXXXXX` (7つの大文字の X) を、`KC_TRNS` については `_______` (7つのアンダースコア)を使います。
|
||||
:::caution
|
||||
|
||||
!> ユーザの混乱を防ぐために、`KC_NO` を使うことをお勧めします。
|
||||
この使用方法はキーマップマクロと異なります。キーマップマクロはほとんど常に`KC_NO`については`XXXXXXX` (7つの大文字の X) を、`KC_TRNS` については `_______` (7つのアンダースコア)を使います。
|
||||
|
||||
:::
|
||||
|
||||
:::caution
|
||||
|
||||
ユーザの混乱を防ぐために、`KC_NO` を使うことをお勧めします。
|
||||
|
||||
:::
|
||||
|
||||
レイアウトマクロは、キーボードに17個のキーがあり、4列それぞれが5行に配置されていることを Configurator に伝えます。スイッチの位置は、0から始まる `k<row><column>` という名前が付けられています。キーマップからキーコードを受け取る上部セクションと、マトリックス内の各キーの位置を指定する下部セクションとが一致する限り、名前自体は実際には問題ではありません。
|
||||
|
||||
@@ -146,7 +158,11 @@ JSON ファイルをビルドする最も簡単な方法は、[Keyboard Layout E
|
||||
|
||||
一部のオブジェクトには、それぞれキーの幅と高さを表す `"w"` 属性キーと `"h"` 属性キーがあります。
|
||||
|
||||
?> `info.json` ファイルの詳細については、[`info.json` 形式](ja/reference_info_json.md) を参照してください。
|
||||
:::tip
|
||||
|
||||
`info.json` ファイルの詳細については、[`info.json` 形式](ja/reference_info_json.md) を参照してください。
|
||||
|
||||
:::
|
||||
|
||||
|
||||
## Configurator がキーをプログラムする方法
|
||||
|
||||
@@ -7,7 +7,11 @@
|
||||
|
||||
このドライバは[分割キーボード](ja/feature_split_keyboard.md) 機能に使います。
|
||||
|
||||
?> この文章でのシリアルは、UART/USART/RS485/RS232 規格の実装ではなく、**一度に1ビットの情報を送信するもの**として読まれるべきです。
|
||||
:::tip
|
||||
|
||||
この文章でのシリアルは、UART/USART/RS485/RS232 規格の実装ではなく、**一度に1ビットの情報を送信するもの**として読まれるべきです。
|
||||
|
||||
:::
|
||||
|
||||
このカテゴリの全てのドライバには以下の特徴があります:
|
||||
* 1本の線上でデータと信号を提供
|
||||
@@ -43,7 +47,11 @@ config.h を介してドライバを設定します:
|
||||
|
||||
#### ARM
|
||||
|
||||
!> bitbang ドライバは bitbang WS2812 ドライバと接続の問題があります
|
||||
:::caution
|
||||
|
||||
bitbang ドライバは bitbang WS2812 ドライバと接続の問題があります
|
||||
|
||||
:::
|
||||
|
||||
上記の一般的なオプションに加えて、halconf.h で `PAL_USE_CALLBACKS` 機能もオンにする必要があります。
|
||||
|
||||
|
||||
+20
-4
@@ -63,7 +63,11 @@ uint16_t get_tapping_term(uint16_t keycode, keyrecord_t *record) {
|
||||
|
||||
通常、これら全てを `TAPPING_TERM` (デフォルト: 200ms) 内で行うと、ファームウェアとホストシステムによって `ax` として登録されます。許容ホールドを有効にすると、別のキーがタップされた場合にモッドタップキーを修飾キーと見なすように処理を変更し、 `X` (`SHIFT`+`x`) と登録されます。
|
||||
|
||||
?> `モッドタップ割り込みの無視`を有効にしている場合、これにより両方の動きが変更されます。通常のキーには、最初のキーが最初に放された場合、あるいは両方のキーが `TAPPING_TERM` より長くホールドされた場合に、修飾キーが追加されます。
|
||||
:::tip
|
||||
|
||||
`モッドタップ割り込みの無視`を有効にしている場合、これにより両方の動きが変更されます。通常のキーには、最初のキーが最初に放された場合、あるいは両方のキーが `TAPPING_TERM` より長くホールドされた場合に、修飾キーが追加されます。
|
||||
|
||||
:::
|
||||
|
||||
この機能をより細かく制御するために、以下を `config.h` に追加することができます:
|
||||
|
||||
@@ -106,9 +110,17 @@ bool get_permissive_hold(uint16_t keycode, keyrecord_t *record) {
|
||||
通常、これは大文字の `X` (`SHIFT`+`x`)、またはモッド + キーを送信します。`モッドタップ割り込みの無視` を有効にすると、ホールドアクションを登録するには、両方のキーを `TAPPING_TERM` の間ホールドする必要があります。この場合、素早いタップは `ax` を送信しますが、両方をホールドすると、大文字の `X` (`SHIFT`+`x`) を出力します。
|
||||
|
||||
|
||||
?> __注意__: これはモディファイアにのみ関係し、レイヤー切り替えキーには関係しません。
|
||||
:::tip
|
||||
|
||||
?> `許容ホールド`を有効にすると、これは両方がどのように動作するかを変更します。通常のキーには、最初のキーが最初に放された場合、あるいは両方のキーが `TAPPING_TERM` より長くホールドされた場合に、修飾キーが追加されます。
|
||||
__注意__: これはモディファイアにのみ関係し、レイヤー切り替えキーには関係しません。
|
||||
|
||||
:::
|
||||
|
||||
:::tip
|
||||
|
||||
`許容ホールド`を有効にすると、これは両方がどのように動作するかを変更します。通常のキーには、最初のキーが最初に放された場合、あるいは両方のキーが `TAPPING_TERM` より長くホールドされた場合に、修飾キーが追加されます。
|
||||
|
||||
:::
|
||||
|
||||
## タッピング強制ホールド
|
||||
|
||||
@@ -132,7 +144,11 @@ bool get_permissive_hold(uint16_t keycode, keyrecord_t *record) {
|
||||
|
||||
`TAPPING_FORCE_HOLD` を使うと、2回目の押下は Shift として解釈され、それをタップして使った後ですぐに修飾キーとして使うことができます。
|
||||
|
||||
!> `TAPPING_FORCE_HOLD` はタッピングトグル(`TT` レイヤーキーコード、ワンショットタップトグルなど)を使うものをすべて破壊します。
|
||||
:::caution
|
||||
|
||||
`TAPPING_FORCE_HOLD` はタッピングトグル(`TT` レイヤーキーコード、ワンショットタップトグルなど)を使うものをすべて破壊します。
|
||||
|
||||
:::
|
||||
|
||||
この機能をより細かく制御するために、以下を `config.h` に追加することができます:
|
||||
|
||||
|
||||
Reference in New Issue
Block a user