qmk-firmware/docs/ja/README.md
Takeshi ISHII b3b115bcc4 [Docs] Update check commands in Japanese documents (#7787)
The Japanese documents included a sample command to check the original document changes. But there was something wrong, so I fixed it.
2020-01-05 23:43:11 -08:00

3.5 KiB

Quantum Mechanical Keyboard Firmware

現在のバージョン ビルド状態 Discord ドキュメントの状態 GitHub 貢献者 GitHub フォーク

QMK ファームウェアとは何か?

QMK (Quantum Mechanical Keyboard)は QMK ファームウェア、QMK ツールボックス、qmk.fm およびそれらのドキュメントを保守するオープンソースコミュニティです。QMK ファームウェアはtmk_keyboard を元にしたキーボードファームウェアで、Atmel AVR コントローラ、より具体的には OLKB 製品ErgoDox EZ キーボードおよび Clueboard 製品 のための幾つかの便利な機能を持ちます。また、ChibiOS を使って ARM チップに移植されています。これを使ってあなたの作った手配線のキーボードあるいはカスタムキーボード PCB で作ったキーボードを動かすことができます。

入手方法

QMK のキーマップ、キーボード、機能に貢献をする予定がある場合、最も簡単なのは、Github を介してリポジトリをフォークし、リポジトリをあなたの開発環境にクローンして変更を加え、それらをプッシュし、プルリクエストを開くことです。

それ以外の場合は、git clone https://github.com/qmk/qmk_firmware を介して直接クローンすることができます。zip または tar ファイルをダウンロードしないでください。コンパイルするためのサブモジュールをダウンロードするために git リポジトリが必要です。

コンパイル方法

コンパイルをする前に、AVR または ARM 開発のための環境をインストールする必要があります。それが完了したら、make コマンドを使用して、以下の表記でキーボードとキーマップをビルドします。

make planck/rev4:default

これは、planckrev4 リビジョンを default キーマップでビルドします。全てのキーボードにリビジョン(サブプロジェクトまたはフォルダとも呼ばれます)があるわけではありません。その場合は省略されます:

make preonic:default

カスタマイズ方法

QMK には、探求すべき多くの機能と、深堀りするためのリファレンス ドキュメントがたくさんあります。ほとんどの機能はキーマップを変更し、キーコードを変更することで活用されます。