Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

1 #3

Merged
merged 40 commits into from
Jun 29, 2020
Merged

1 #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
40 commits
Select commit Hold shift + click to select a range
39b483a
Fix maja info.json (#9511)
fauxpark Jun 23, 2020
c30170b
[Keyboard] added 4pplet keyboards (#8935)
Jun 24, 2020
9b398a8
Partial and window screenshots (#9332)
spidey3 Jun 24, 2020
4b80ee4
Add Hebrew keymap aliases (#9383)
spidey3 Jun 24, 2020
a4b2baa
[Update] Japanese translation of docs/newbs_building_firmware_configu…
mtei Jun 24, 2020
4d21856
[Keymap] Add pierrec83's gherkin keymap (#9465)
pierrechevalier83 Jun 24, 2020
598c392
Add VIA support to Noxary 268 (#9449)
Rozakiin Jun 24, 2020
2521b97
add_adjust_layer (#9532)
Jun 24, 2020
ce91b36
[Update] Japanese Translation of docs/feature_layers.md (#9537)
mtei Jun 25, 2020
9b85bd6
feat: add dvorak-fr as extra keymap (#9512)
GreatWizard Jun 25, 2020
45c73b1
Minor keymap fix (#9534)
Xyverz Jun 25, 2020
995464c
[Docs] fix file path (#9540)
shelaf Jun 25, 2020
c8b35b6
Jotanck (#9531)
Jun 25, 2020
7a710fb
[Keyboard] adding Rewind keyboard (#9497)
Rossman360 Jun 25, 2020
6d88794
M0lly: add support for VIA (#9535)
TerryMathews Jun 25, 2020
c2dd19d
Fix error_log complaint about Helix boards (#9528)
fauxpark Jun 25, 2020
9236c3a
[Keymap] Adding custom keymaps (#9426)
adamdehaven Jun 26, 2020
30f4b4d
[Keymap] pinpox keymap for dz60 (#9494)
pinpox Jun 26, 2020
7369e19
tap toggle to lower layer (#9542)
Jun 26, 2020
ac7b1d0
[Update]JISplite89 Readme and LED nums (#9554)
Salicylic-acid3 Jun 27, 2020
751a178
Add JD40 keymap for myoung34 (#9545)
myoung34 Jun 27, 2020
6574ac5
[Docs] Japanese translation of docs/documentation_best_practices.md (…
umi-umi Jun 28, 2020
097df6a
[Docs] Japanese translation of docs/documentation_templates.md (#9523)
umi-umi Jun 28, 2020
c85e010
Add missing info.jsons for a few boards (#9549)
fauxpark Jun 28, 2020
7baeaae
Trinity XT tkl - New Keyboard (#9483)
Xelus22 Jun 28, 2020
d36d5ec
Klackygears add user and handwired brain (#9154)
Klackygears Jun 28, 2020
e184da9
[Update] Japanese translation of docs/cli.md and docs/cli_commands.md…
mtei Jun 28, 2020
3d45861
Fix ordering for new info.jsons (#9567)
fauxpark Jun 28, 2020
2344b68
Fix siemens_tastatur info.json (#9568)
fauxpark Jun 28, 2020
b87895d
Move Wete to ramonimbao folder (#9569)
ramonimbao Jun 28, 2020
b27c20d
Added DFU instructions for XD004 board (#9565)
M0les Jun 28, 2020
32a47e7
Add Herringbone keyboard (#9495)
ramonimbao Jun 28, 2020
a8904d4
Add GHS.RAR keyboard (#9561)
ramonimbao Jun 28, 2020
0928496
[Keyboard] Refactor JJ50 keyboard mapping to current standard (#9415)
GreatWizard Jun 28, 2020
b215bc3
Add workman layout in JJ50 default keymap (#9574)
GreatWizard Jun 28, 2020
51509ec
Add DZ60 keymap lint_kid (#9477)
mcginnisa Jun 28, 2020
2c0201e
[Keyboard] Coupe and Sedan keyboards (#9539)
AlisGraveNil Jun 29, 2020
62ceb46
Fixed MACLOCK key (#9555)
Xyverz Jun 29, 2020
7c17b87
Fix WORKMAN layer typo in dudeofawesome planck/preonic (#9576)
GreatWizard Jun 29, 2020
4e4a344
[Docs] Japanese translation of docs/compatible_microcontrollers.md (#…
umi-umi Jun 29, 2020
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/documentation_best_practices.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,4 +61,4 @@ This page describes my cool feature. You can use my cool feature to make coffee
|KC_SUGAR||Order Sugar|
```

Place your documentation into `docs/feature_<my_cool_feature>.md`, and add that file to the appropriate place in `docs/_sidebar.md`. If you have added any keycodes be sure to add them to `docs/keycodes.md` with a link back to your feature page.
Place your documentation into `docs/feature_<my_cool_feature>.md`, and add that file to the appropriate place in `docs/_summary.md`. If you have added any keycodes be sure to add them to `docs/keycodes.md` with a link back to your feature page.
15 changes: 7 additions & 8 deletions docs/ja/cli.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# QMK CLI :id=qmk-cli

<!---
original document: 0.8.58:docs/cli.md
git diff 0.8.58 HEAD -- docs/cli.md | cat
original document: 0.9.19:docs/cli.md
git diff 0.9.19 HEAD -- docs/cli.md | cat
-->

## 概要 :id=overview
Expand All @@ -11,25 +11,24 @@ QMK CLI を使用すると QMK キーボードの構築と作業が簡単にな

### 必要事項 :id=requirements

CLI は Python 3.5 以上を必要とします。我々は必要事項の数を少なくしようとしていますが、[`requirements.txt`](https://github.com/qmk/qmk_firmware/blob/master/requirements.txt) に列挙されているパッケージもインストールする必要があります。これらは QMK CLI をインストールするときに自動的にインストールされます。
QMK は Python 3.6 以上を必要とします。我々は必要事項の数を少なくしようとしていますが、[`requirements.txt`](https://github.com/qmk/qmk_firmware/blob/master/requirements.txt) に列挙されているパッケージもインストールする必要があります。これらは QMK CLI をインストールするときに自動的にインストールされます。

### Homebrew を使ったインストール (macOS、いくつかの Linux) :id=install-using-homebrew

[Homebrew](https://brew.sh) をインストールしている場合は、タップして QMK をインストールすることができます:

```
brew tap qmk/qmk
brew install qmk
brew install qmk/qmk/qmk
export QMK_HOME='~/qmk_firmware' # オプション、`qmk_firmware` の場所を設定します
qmk setup # これは `qmk/qmk_firmware` をクローンし、オプションでビルド環境をセットアップします
```

### easy_install あるいは pip を使ってインストール :id=install-using-easy_install-or-pip
### pip を使ってインストール :id=install-using-easy_install-or-pip

上のリストにあなたのシステムがない場合は、QMK を手動でインストールすることができます。最初に、python 3.5 (以降)をインストールしていて、pip をインストールしていることを確認してください。次に以下のコマンドを使って QMK をインストールします:
上で列挙した中にあなたのシステムがない場合は、QMK を手動でインストールすることができます。最初に、python 3.6 (以降)をインストールしていて、pip をインストールしていることを確認してください。次に以下のコマンドを使って QMK をインストールします:

```
pip3 install qmk
python3 -m pip install qmk
export QMK_HOME='~/qmk_firmware' # オプション、`qmk_firmware` の場所を設定します
qmk setup # これは `qmk/qmk_firmware` をクローンし、オプションでビルド環境をセットアップします
```
Expand Down
160 changes: 99 additions & 61 deletions docs/ja/cli_commands.md
Original file line number Diff line number Diff line change
@@ -1,48 +1,18 @@
# QMK CLI コマンド

<!---
original document: 0.8.58:docs/cli.md
git diff 0.8.58 HEAD -- docs/cli.md | cat
original document: 0.9.19:docs/cli_command.md
git diff 0.9.19 HEAD -- docs/cli_command.md | cat
-->

# CLI コマンド

## `qmk cformat`

このコマンドは clang-format を使って C コードを整形します。

引数無しで実行すると、変更された全てのコアコードを整形します。デフォルトでは `git diff` で `origin/master` をチェックし、ブランチは `-b <branch_name>` を使って変更できます。

`-a` で全てのコアコードを整形するか、コマンドラインでファイル名を渡して特定のファイルに対して実行します。

**指定したファイルに対する使い方**:

```
qmk cformat [file1] [file2] [...] [fileN]
```

**全てのコアファイルに対する使い方**:

```
qmk cformat -a
```

**origin/master で変更されたファイルのみに対する使い方**:

```
qmk cformat
```

**branch_name で変更されたファイルのみに対する使い方**:

```
qmk cformat -b branch_name
```
# ユーザー用コマンド

## `qmk compile`

このコマンドにより、任意のディレクトリからファームウェアをコンパイルすることができます。<https://config.qmk.fm> からエクスポートした JSON をコンパイルするか、リポジトリ内でキーマップをコンパイルするか、現在の作業ディレクトリでキーボードをコンパイルすることができます。

このコマンドはディレクトリを認識します。キーボードやキーマップのディレクトリにいる場合、自動的に KEYBOARD や KEYMAP を入力します。

**Configurator Exports での使い方**:

```
Expand Down Expand Up @@ -113,6 +83,8 @@ $ qmk compile -kb dz60
このコマンドは `qmk compile` に似ていますが、ブートローダを対象にすることもできます。ブートローダはオプションで、デフォルトでは `:flash` に設定されています。
違うブートローダを指定するには、`-bl <bootloader>` を使ってください。利用可能なブートローダの詳細については、[ファームウェアを書き込む](ja/flashing.md)を見てください。

このコマンドはディレクトリを認識します。キーボードやキーマップのディレクトリにいる場合、自動的に KEYBOARD や KEYMAP を入力します。

**Configurator Exports での使い方**:

```
Expand Down Expand Up @@ -141,16 +113,6 @@ qmk flash -b
qmk config [-ro] [config_token1] [config_token2] [...] [config_tokenN]
```

## `qmk docs`

このコマンドは、ドキュメントを参照または改善するために使うことができるローカル HTTP サーバを起動します。デフォルトのポートは 8936 です。

**使用法**:

```
qmk docs [-p PORT]
```

## `qmk doctor`

このコマンドは環境を調査し、潜在的なビルドあるいは書き込みの問題について警告します。必要に応じてそれらの多くを修正できます。
Expand All @@ -175,36 +137,40 @@ qmk doctor [-y] [-n]

qmk doctor -n

## `qmk json2c`
## `qmk info`

QMK Configurator からエクスポートしたものから keymap.c を生成します
QMK のキーボードやキーマップに関する情報を表示します。キーボードに関する情報を取得したり、レイアウトを表示したり、基礎となるキーマトリックスを表示したり、JSON キーマップをきれいに印刷したりするのに使用できます

**使用法**:

```
qmk json2c [-o OUTPUT] filename
qmk info [-f FORMAT] [-m] [-l] [-km KEYMAP] [-kb KEYBOARD]
```

## `qmk kle2json`
このコマンドはディレクトリを認識します。キーボードやキーマップのディレクトリにいる場合、自動的に KEYBOARD や KEYMAP を入力します。

このコマンドにより、生の KLE データから QMK Configurator の JSON へ変換することができます。絶対パスあるいは現在のディレクトリ内のファイル名のいずれかを受け取ります。デフォルトでは、`info.json` が既に存在している場合は上書きしません。上書きするには、`-f` あるいは `--force` フラグを使ってください。
**例**:

**使用法**:
キーボードの基本情報を表示する:

```
qmk kle2json [-f] <filename>
```
qmk info -kb planck/rev5

**例**:
キーボードのマトリクスを表示する:

```
$ qmk kle2json kle.txt
☒ File info.json already exists, use -f or --force to overwrite.
```
qmk info -kb ergodox_ez -m

キーボードの JSON キーマップを表示する:

qmk info -kb clueboard/california -km default

## `qmk json2c`

QMK Configurator からエクスポートしたものから keymap.c を生成します。

**使用法**:

```
$ qmk kle2json -f kle.txt -f
Ψ Wrote out to info.json
qmk json2c [-o OUTPUT] filename
```

## `qmk list-keyboards`
Expand All @@ -221,6 +187,8 @@ qmk list-keyboards

このコマンドは指定されたキーボード(とリビジョン)の全てのキーマップを列挙します。

このコマンドはディレクトリを認識します。キーボードのディレクトリにいる場合、自動的に KEYBOARD を入力します。

**使用法**:

```
Expand All @@ -231,12 +199,82 @@ qmk list-keymaps -kb planck/ez

このコマンドは、キーボードの既存のデフォルトのキーマップに基づいて新しいキーマップを作成します。

このコマンドはディレクトリを認識します。キーボードやキーマップのディレクトリにいる場合、自動的に KEYBOARD や KEYMAP を入力します。

**使用法**:

```
qmk new-keymap [-kb KEYBOARD] [-km KEYMAP]
```

---

# 開発者用コマンド

## `qmk cformat`

このコマンドは clang-format を使って C コードを整形します。

引数無しで実行すると、変更された全てのコアコードを整形します。デフォルトでは `git diff` で `origin/master` をチェックし、ブランチは `-b <branch_name>` を使って変更できます。

`-a` で全てのコアコードを整形するか、コマンドラインでファイル名を渡して特定のファイルに対して実行します。

**指定したファイルに対する使い方**:

```
qmk cformat [file1] [file2] [...] [fileN]
```

**全てのコアファイルに対する使い方**:

```
qmk cformat -a
```

**origin/master で変更されたファイルのみに対する使い方**:

```
qmk cformat
```

**branch_name で変更されたファイルのみに対する使い方**:

```
qmk cformat -b branch_name
```

## `qmk docs`

このコマンドは、ドキュメントを参照または改善するために使うことができるローカル HTTP サーバを起動します。デフォルトのポートは 8936 です。

**使用法**:

```
qmk docs [-p PORT]
```

## `qmk kle2json`

このコマンドにより、生の KLE データから QMK Configurator の JSON へ変換することができます。絶対パスあるいは現在のディレクトリ内のファイル名のいずれかを受け取ります。デフォルトでは、`info.json` が既に存在している場合は上書きしません。上書きするには、`-f` あるいは `--force` フラグを使ってください。

**使用法**:

```
qmk kle2json [-f] <filename>
```

**例**:

```
$ qmk kle2json kle.txt
☒ File info.json already exists, use -f or --force to overwrite.
```

```
$ qmk kle2json -f kle.txt -f
Ψ Wrote out to info.json
```

## `qmk pyformat`

このコマンドは `qmk_firmware` 内の python コードを整形します。
Expand Down
42 changes: 42 additions & 0 deletions docs/ja/compatible_microcontrollers.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# 互換性のあるマイクロコントローラ

<!---
original document: 0.9.19:docs/compatible_microcontrollers.md
git diff 0.9.19 HEAD -- docs/compatible_microcontrollers.md | cat
-->

QMK は十分な容量のフラッシュメモリを備えた USB 対応 AVR または ARM マイクロコントローラで実行されます - 一般的に 32kB 以上ですが、ほとんどの機能を無効にすると*ほんの* 16kB に詰め込むことができます。

## Atmel AVR

以下は、USB スタックとして [LUFA](https://www.fourwalledcubicle.com/LUFA.php) を使います:

* [ATmega16U2](https://www.microchip.com/wwwproducts/en/ATmega16U2) / [ATmega32U2](https://www.microchip.com/wwwproducts/en/ATmega32U2)
* [ATmega16U4](https://www.microchip.com/wwwproducts/en/ATmega16U4) / [ATmega32U4](https://www.microchip.com/wwwproducts/en/ATmega32U4)
* [AT90USB64](https://www.microchip.com/wwwproducts/en/AT90USB646) / [AT90USB128](https://www.microchip.com/wwwproducts/en/AT90USB1286)

組み込みの USB インターフェースを持たない、いくつかの MCU は代わりに [V-USB](https://www.obdev.at/products/vusb/index.html) を使います:

* [ATmega32A](https://www.microchip.com/wwwproducts/en/ATmega32A)
* [ATmega328P](https://www.microchip.com/wwwproducts/en/ATmega328P)
* [ATmega328](https://www.microchip.com/wwwproducts/en/ATmega328)

## ARM

[ChibiOS](http://www.chibios.org) がサポートする USB 付きの ARM チップを使うこともできます。ほとんどのチップには十分な容量のフラッシュメモリがあります。動作するとわかっているのは:

### STMicroelectronics (STM32)

* [STM32F0x2](https://www.st.com/en/microcontrollers-microprocessors/stm32f0x2.html)
* [STM32F103](https://www.st.com/en/microcontrollers-microprocessors/stm32f103.html)
* [STM32F303](https://www.st.com/en/microcontrollers-microprocessors/stm32f303.html)

### NXP (Kinetis)

* [MKL26Z64](https://www.nxp.com/products/processors-and-microcontrollers/arm-microcontrollers/general-purpose-mcus/kl-series-cortex-m0-plus/kinetis-kl2x-72-96-mhz-usb-ultra-low-power-microcontrollers-mcus-based-on-arm-cortex-m0-plus-core:KL2x)
* [MK20DX128](https://www.nxp.com/products/processors-and-microcontrollers/arm-microcontrollers/general-purpose-mcus/k-series-cortex-m4/k2x-usb/kinetis-k20-50-mhz-full-speed-usb-mixed-signal-integration-microcontrollers-based-on-arm-cortex-m4-core:K20_50)
* [MK20DX256](https://www.nxp.com/products/processors-and-microcontrollers/arm-microcontrollers/general-purpose-mcus/k-series-cortex-m4/k2x-usb/kinetis-k20-72-mhz-full-speed-usb-mixed-signal-integration-microcontrollers-mcus-based-on-arm-cortex-m4-core:K20_72)

## Atmel ATSAM

Atmel の ATSAM マイクロコントローラの一つである、[Massdrop keyboards](https://github.com/qmk/qmk_firmware/tree/master/keyboards/massdrop) で使用されている [ATSAMD51J18A](https://www.microchip.com/wwwproducts/en/ATSAMD51J18A) には限定的なサポートがあります。
67 changes: 67 additions & 0 deletions docs/ja/configurator_step_by_step.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
# QMK Configurator: ステップ・バイ・ステップ

<!---
grep --no-filename "^[ ]*git diff" docs/ja/*.md | sh
original document: 0.9.0:docs/configurator_step_by_step.md
git diff 0.9.0 HEAD -- docs/configurator_step_by_step.md | cat
-->

このページでは、QMK Configurator でファームウェアを構築する手順を説明します。

## ステップ 1: キーボードを選ぶ

ドロップダウンボックスをクリックして、キーマップを作成するキーボードを選択します。

?> **キーボードに複数のバージョンがある場合は、正しいバージョンを選択してください。**

大事なことなのでもう一度言います。

!> **正しいバージョンを選択してください!**

キーボードが QMK を搭載していると宣伝されていてもリストにない場合は、開発者がまだ作業中か、私たちがまだマージするきっかけがなかった可能性があります。
アクティブな [プルリクエスト](https://github.com/qmk/qmk_firmware/pulls?q=is%3Aopen+is%3Apr+label%3Akeyboard) がない場合、[qmk_firmware](https://github.com/qmk/qmk_firmware/issues)で報告して、その特定のキーボードのサポートをリクエストします。
製作者自身の GitHub アカウントにある QMK 搭載キーボードもあります。
それも再確認してください。

## ステップ2: キーボードのレイアウトを選択する

作成したいと思うキーマップに最も近いレイアウトを選択します。一部のキーボードには、まだ十分なレイアウトや正しいレイアウトが定義されていません。これらは将来サポートされる予定です。

## ステップ3: キーマップの名前を決める

お好みの名前をキーマップにつけます。

?> コンパイル時に問題が発生した場合は、もしかすると QMK ファームウェアリポジトリに既に同じ名前が存在しているのかもしれません。名前を変更してみてください。

## ステップ4: キーマップを定義する

キーコードの入力は、3つの方法のいずれかで行います。

1. ドラッグ・アンド・ドロップ
2. レイアウト上の空の場所をクリックして、希望するキーコードをクリックします
3. レイアウト上の空の場所をクリックして、キーボードの物理キーを押します

?> マウスをキーの上に置くと、そのキーコードの機能の短い説明文が出ます。より詳細な説明については以下を見てください:

* [基本的なキーコードリファレンス](ja/keycodes_basic.md)
* [高度なキーコードリファレンス](ja/feature_advanced_keycodes.md)

!> 選択したレイアウトが物理的なビルドと一致しない場合は、使用していないキーは空白のままにしておきます。どのキーが使用されているかわからない場合、例えば、バックスペースキーは1つだが `LAYOUT_all` には2つのキーがある場合は、同じキーコードを両方の場所に配置してください。

## ステップ5: 後日のためにキーマップを保存する

キーマップに満足するか、または後で作業したい場合は、`Export Keymap' ボタンを押します。
これでキーマップがあなたのコンピュータに保存されます。
その後、`Import Keymap` ボタンを押すことで、この .json ファイルを後で読み込むことができます。

!> **注意:** このファイルは、kbfirmware.com またはその他のツールに使用される .json ファイルと同じ形式ではありません。これらのツールにこの .json を使用したり、QMK Configurator でこれらのツールの .json を使用しようとすると、問題が発生します。

## ステップ6: ファームウェアをコンパイルする

緑色の `Compile` ボタンを押します。

コンパイルが完了すると、緑色の `Download Firmware` ボタンを押すことができます。

## 次のステップ: キーボードに書き込む(フラッシュする)

[ファームウェアを書きこむ](ja/newbs_flashing.md) を参照してください。
Loading