docs/ja/getting_started_introduction.md

   1 # はじめに
   2
   3 <!---
   4   original document: d598f01cb:getting_started_introduction.md
   5   git diff d598f01cb HEAD getting_started_introduction.md | cat
   6 -->
   7
   8 このページでは、QMK プロジェクトで作業するために知っておくべき基本的な情報について説明しようと思います。Unix シェルの操作に精通していることを前提としていますが、C について、または make を使ったコンパイルについて精通しているとは想定していません。
   9
  10 ## 基本的な QMK の構造
  11
  12 QMK は [Jun Wako](https://github.com/tmk) の [tmk_keyboard](https://github.com/tmk/tmk_keyboard) プロジェクトのフォークです。変更された元の TMK コードは、`tmk_core` フォルダで見つけることができます。プロジェクトへの QMK の追加は、`quantum` フォルダで見つけることができます。キーボードプロジェクトは `handwired` および `keyboard` フォルダで見つけることができます。
  13
  14 ### ユーザスペースの構造
  15
  16 `users` フォルダ内は各ユーザのためのディレクトリです。これはユーザがキーボード間で使うかもしれないコードを置くためのフォルダです。詳細は[ユーザスペース機能](ja/feature_userspace.md) のドキュメントを見てください。
  17
  18 ### キーボードプロジェクトの構造
  19
  20 `keyboards` フォルダ、そのサブフォルダ `handwired`、ベンダと製品のサブディレクトリ (例えば、`clueboard`) の中には、各キーボードプロジェクトのためのディレクトリ (例えば `qmk_firmware/keyboards/clueboard/2x1800`) があります。その中には、以下の構造があります:
  21
  22 * `keymaps/`: ビルドできる様々なキーマップ
  23 * `rules.mk`: デフォルトの "make" オプションを設定するファイル。このファイルを直接編集しないでください。代わりにキーマップ固有の `rules.mk` を使ってください。
  24 * `config.h`: デフォルトのコンパイル時のオプションを設定するファイル。このファイルを直接編集しないでください。代わりにキーマップ固有の `config.h` を使ってください。
  25 * `info.json`: QMK Configurator のためのレイアウトの設定に使われるファイル。詳細は [Configurator サポート](ja/reference_configurator_support.md)を見てください。
  26 * `readme.md`: キーボードの簡単な概要
  27 * `<keyboardName>.h`: このファイルは、キーボードのスイッチマトリックスに対してキーボードレイアウトが定義されるファイルです。
  28 * `<keyboardName>.c`: このファイルには、キーボードのためのカスタムコードがあります。
  29
  30 プロジェクトの構造についての詳細は、[QMK キーボードガイドライン](ja/hardware_keyboard_guidelines.md)を見てください。
  31
  32 ### キーマップ構造
  33
  34 全てのキーマップフォルダには、以下のファイルがあります。`keymap.c` だけが必須で、残りのファイルが見つからない場合は、デフォルトのオプションが選択されます。
  35
  36 * `config.h`: キーマップを設定するためのオプション
  37 * `keymap.c`: 全てのキーマップコード。必須
  38 * `rules.mk`: 有効になっている QMK の機能
  39 * `readme.md`: キーマップの説明。他の人が使う方法および機能の説明。imgur のようなサービスに画像をアップロードしてください。
  40
  41 # `config.h` ファイル
  42
  43 3つの `config.h` の場所が考えられます:
  44
  45 * キーボード (`/keyboards/<keyboard>/config.h`)
  46 * ユーザスペース (`/users/<user>/config.h`)
  47 * キーマップ (`/keyboards/<keyboard>/keymaps/<keymap>/config.h`)
  48
  49 ビルドシステムは自動的に上の順に config ファイルを取得します。前の `config.h` で設定された設定を上書きしたい場合は、変更したい設定の準備のために最初に定型コードを置く必要があります。
  50
  51 ```
  52 #pragma once
  53 ```
  54
  55 次に、前の `config.h` ファイルの設定を上書きするために、設定を `#undef` し再び `#define` する必要があります。
  56
  57 定型コードと設定は、以下のようになります:
  58
  59 ```
  60 #pragma once
  61
  62 // ここに上書きします！
  63 #undef MY_SETTING
  64 #define MY_SETTING 4
  65 ```