チュートリアル

• 入門
• セットアップ
• 初めてのファームウェアの構築
• ファームウェアのフラッシュ
• 手助けを得る/サポート
• 他のリソース
• シラバス

FAQ

• 一般的な FAQ
• QMK のビルド/コンパイル
• QMK のデバッグ
• QMK のトラブルシューティング
• キーマップ FAQ
• 用語

Configurator

• 概要
• ステップ・バイ・ステップ
• トラブルシューティング
• QMK API
  • 概要
  • API ドキュメント
  • キーボードサポート
  • デフォルトキーマップの追加

CLI

• 概要
• 設定
• コマンド
• Tab 補完

QMK を使う

• ガイド

  • 機能のカスタマイズ
  • Zadig を使ったドライバのインストール
  • キーマップの概要
  • 開発環境
    • Docker のガイド
    • Vagrant のガイド
  • 書き込み
    • 書き込み
    • ATmega32A の書き込み (ps2avrgb)
  • IDE
    • QMK での Eclipse の使用
    • QMK での VSCode の使用
  • Git のベストプラクティス
    • 入門
    • フォーク
    • マージの競合の解決
    • ブランチの修正
  • キーボードを作る
    • Hand Wiring ガイド
    • ISP 書き込みガイド

• 単純なキーコード

  • 完全なリスト
  • 基本的なキーコード
  • 言語固有のキーコード
  • 修飾キー
  • Quantum キーコード

• 高度なキーコード

  • コマンド
  • 動的マクロ
  • グレイブ エスケープ
  • リーダーキー
  • モッドタップ
  • マクロ
  • マウスキー
  • Space Cadet Shift
  • US ANSI シフトキー

• ソフトウェア機能

  • 自動シフト
  • コンボ
  • デバウンス API
  • キーロック
  • レイヤー
  • ワンショットキー
  • ポインティング デバイス
  • ロー HID
  • シーケンサー
  • スワップハンド
  • タップダンス
  • タップホールド設定
  • ユニコード
  • ユーザスペース
  • WPM 計算

• ハードウェア機能

  • 表示
    • HD44780 LCD コントローラ
    • OLED ドライバ
  • 電飾
    • バックライト
    • LED マトリックス
    • RGB ライト
    • RGB マトリックス
  • オーディオ
  • Bluetooth
  • ブートマジック
  • カスタムマトリックス
  • DIP スイッチ
  • エンコーダ
  • 触覚フィードバック
  • ジョイスティック
  • LED インジケータ
  • Proton C 変換
  • PS/2 マウス
  • 分割キーボード
  • 速記
  • 感熱式プリンタ
  • Velocikey

QMK の開発

• PR チェックリスト

• 互換性を破る変更/Breaking changes

  • 概要
  • プルリクエストにフラグが付けられた
  • 最近の変更履歴
  • 過去の互換性を破る変更

• C 開発

  • ARM デバッグ ガイド
  • AVR プロセッサ
  • コーディング規約
  • 互換性のあるマイクロコントローラ
  • ドライバ
    • ADC ドライバ
    • オーディオドライバ
    • I2C ドライバ
    • SPI ドライバ
    • WS2812 ドライバ
    • EEPROM ドライバ
    • シリアル ドライバ
    • UART ドライバ
  • GPIO 制御
  • キーボード ガイドライン

• Python 開発

  • コーディング規約
  • QMK CLI 開発

• Configurator 開発

  • QMK API
    • 開発環境
    • アーキテクチャの概要

• ハードウェアプラットフォーム開発

  • Arm/ChibiOS
    • MCU の選択
    • 早期初期化

• QMK Reference

  • QMK への貢献
  • QMK ドキュメントの翻訳
  • 設定オプション
  • データ駆動型コンフィギュレーション
  • Make ドキュメント
  • ドキュメント ベストプラクティス
  • ドキュメント テンプレート
  • コミュニティレイアウト
  • ユニットテスト
  • 便利な関数
  • info.json 形式

• より深く知るために

  • キーボードがどのように動作するか
  • マトリックスがどのように動作するか
  • QMK を理解する

• QMK の内部詳細(作成中)

  • 定義
  • 入力コールバック登録
  • Midi デバイス
  • Midi デバイスのセットアップ手順
  • Midi ユーティリティ
  • Midi 送信関数
  • Sysex Tools