shela ee88feb759 [Docs] Update Japanese translation (#8015) 5 years ago
..
README.md b3b115bcc4 [Docs] Update check commands in Japanese documents (#7787) 5 years ago
_summary.md ee88feb759 [Docs] Update Japanese translation (#8015) 5 years ago
arm_debugging.md ee88feb759 [Docs] Update Japanese translation (#8015) 5 years ago
cli.md b3b115bcc4 [Docs] Update check commands in Japanese documents (#7787) 5 years ago
cli_configuration.md b3b115bcc4 [Docs] Update check commands in Japanese documents (#7787) 5 years ago
config_options.md ee88feb759 [Docs] Update Japanese translation (#8015) 5 years ago
contributing.md b3b115bcc4 [Docs] Update check commands in Japanese documents (#7787) 5 years ago
driver_installation_zadig.md b3b115bcc4 [Docs] Update check commands in Japanese documents (#7787) 5 years ago
faq.md b3b115bcc4 [Docs] Update check commands in Japanese documents (#7787) 5 years ago
faq_build.md 8b80cf853b [Docs] Update Japanese translation (#7783) 5 years ago
faq_debug.md b3b115bcc4 [Docs] Update check commands in Japanese documents (#7787) 5 years ago
faq_general.md b3b115bcc4 [Docs] Update check commands in Japanese documents (#7787) 5 years ago
faq_keymap.md b3b115bcc4 [Docs] Update check commands in Japanese documents (#7787) 5 years ago
getting_started_getting_help.md b3b115bcc4 [Docs] Update check commands in Japanese documents (#7787) 5 years ago
getting_started_github.md b3b115bcc4 [Docs] Update check commands in Japanese documents (#7787) 5 years ago
getting_started_introduction.md b3b115bcc4 [Docs] Update check commands in Japanese documents (#7787) 5 years ago
newbs.md b3b115bcc4 [Docs] Update check commands in Japanese documents (#7787) 5 years ago
newbs_building_firmware.md 8b80cf853b [Docs] Update Japanese translation (#7783) 5 years ago
newbs_building_firmware_configurator.md ee88feb759 [Docs] Update Japanese translation (#8015) 5 years ago
newbs_flashing.md ee88feb759 [Docs] Update Japanese translation (#8015) 5 years ago
newbs_getting_started.md ee88feb759 [Docs] Update Japanese translation (#8015) 5 years ago
newbs_git_best_practices.md b3b115bcc4 [Docs] Update check commands in Japanese documents (#7787) 5 years ago
newbs_git_resolving_merge_conflicts.md b3b115bcc4 [Docs] Update check commands in Japanese documents (#7787) 5 years ago
newbs_git_resynchronize_a_branch.md ee88feb759 [Docs] Update Japanese translation (#8015) 5 years ago
newbs_git_using_your_master_branch.md ee88feb759 [Docs] Update Japanese translation (#8015) 5 years ago
newbs_learn_more_resources.md ee88feb759 [Docs] Update Japanese translation (#8015) 5 years ago
newbs_testing_debugging.md ee88feb759 [Docs] Update Japanese translation (#8015) 5 years ago

README.md

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