diff options
Diffstat (limited to 'docs/ja/documentation_templates.md')
-rw-r--r-- | docs/ja/documentation_templates.md | 45 |
1 files changed, 45 insertions, 0 deletions
diff --git a/docs/ja/documentation_templates.md b/docs/ja/documentation_templates.md new file mode 100644 index 000000000..0ba3caf5e --- /dev/null +++ b/docs/ja/documentation_templates.md | |||
@@ -0,0 +1,45 @@ | |||
1 | # ドキュメントテンプレート | ||
2 | |||
3 | <!--- | ||
4 | original document: 0.13.15:docs/documentation_templates.md | ||
5 | git diff 0.13.15 HEAD -- docs/documentation_templates.md | cat | ||
6 | --> | ||
7 | |||
8 | このページでは、新しいキーマップやキーボードを QMK に提出する際に使うべきテンプレートをまとめています。 | ||
9 | |||
10 | ## キーマップ `readme.md` テンプレート :id=keyboard-readmemd-template | ||
11 | |||
12 | ほとんどのキーマップには、レイアウトを表す画像があります。画像を作成するには、[Keyboard Layout Editor](https://keyboard-layout-editor.com) を使うことができます。画像は [Imgur](https://imgur.com) や別のホスティングサービスにアップロードし、プルリクエストに画像を含めないでください。 | ||
13 | |||
14 | 画像の下には、キーマップを理解してもらうための簡単な説明文を書いてください。 | ||
15 | |||
16 | ``` | ||
17 |  | ||
18 | |||
19 | # Default Clueboard Layout | ||
20 | |||
21 | This is the default layout that comes flashed on every Clueboard. For the most | ||
22 | part it's a straightforward and easy to follow layout. The only unusual key is | ||
23 | the key in the upper left, which sends Escape normally, but Grave when any of | ||
24 | the Ctrl, Alt, or GUI modifiers are held down. | ||
25 | ``` | ||
26 | |||
27 | ## キーボード `readme.md` テンプレート | ||
28 | |||
29 | ``` | ||
30 | # Planck | ||
31 | |||
32 |  | ||
33 | |||
34 | A compact 40% (12x4) ortholinear keyboard kit made and sold by OLKB and Massdrop. [More info on qmk.fm](https://qmk.fm/planck/) | ||
35 | |||
36 | * Keyboard Maintainer: [Jack Humbert](https://github.com/jackhumbert) | ||
37 | * Hardware Supported: Planck PCB rev1, rev2, rev3, rev4, Teensy 2.0 | ||
38 | * Hardware Availability: [OLKB.com](https://olkb.com), [Massdrop](https://www.massdrop.com/buy/planck-mechanical-keyboard?mode=guest_open) | ||
39 | |||
40 | Make example for this keyboard (after setting up your build environment): | ||
41 | |||
42 | make planck/rev4:default | ||
43 | |||
44 | See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). | ||
45 | ``` | ||