Skip to content

Commit 94676e6

Browse files
committed
Improves MarkDown standards conformity
1 parent 894984e commit 94676e6

11 files changed

+120
-58
lines changed

corne-cherry/doc/v2/buildguide_jp.md

+15-4
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,10 @@
44
[Corne Cherry v3 はこちら](https://github.com/foostan/crkbd/blob/master/corne-cherry/doc/v3/buildguide_jp.md)
55

66
## 部品
7+
78
### 必須
8-
| 名前 || 備考 |
9+
10+
| 名前 || 備考 |
911
|:-|:-|:-|
1012
| PCB | 2枚 | |
1113
| トッププレート | 2枚 | |
@@ -29,15 +31,17 @@
2931
| Micro USBケーブル | 1本 | |
3032

3133
### オプション
34+
3235
| 名前 || 備考 |
3336
|:-|:-|:-|
3437
| SK6812MINI | 54個 | 上向き実装 42個、下向き実装 12個 |
3538

3639
![01](https://user-images.githubusercontent.com/736191/54487431-789a6c00-48d9-11e9-9390-a8510b19ba34.jpg)
3740

3841
## 事前準備
42+
3943
ファームウェアを自分でビルドする場合は環境を整備するのに時間がかかるのではじめに取り掛かっておくことをおすすめします。\
40-
詳しくは https://github.com/foostan/crkbd/blob/master/doc/firmware_jp.md を参照してください。
44+
詳しくは <https://github.com/foostan/crkbd/blob/master/doc/firmware_jp.md> を参照してください。
4145

4246
## 実装
4347

@@ -56,7 +60,7 @@ PCBはリバーシブルになっているので、最初にどちらを左用/
5660

5761
![03](https://user-images.githubusercontent.com/736191/54487433-789a6c00-48d9-11e9-991b-92264a793ec9.jpg)
5862

59-
ダイオードの向きは次のとおりです。チップ部品の「|||」印が、ダイオードマーク「|◁」の「|」の方に向けるように取り付けます。
63+
ダイオードの向きは次のとおりです。チップ部品の「|||」印が、ダイオードマーク「|◁」の「|」の方に向けるように取り付けます。
6064

6165
![04](https://user-images.githubusercontent.com/736191/54487434-79330280-48d9-11e9-82be-a9d98803a417.jpg)
6266

@@ -89,6 +93,7 @@ PCBはリバーシブルになっているので、最初にどちらを左用/
8993
![09](https://user-images.githubusercontent.com/736191/54487439-79cb9900-48d9-11e9-9a57-80697fa8b484.jpg)
9094

9195
### OLEDモジュールのためのジャンパとピンソケット
96+
9297
OLEDモジュールを利用する場合は下記のようにジャンパします。
9398
なお**表面のみジャンパしてください**
9499

@@ -100,6 +105,7 @@ OLEDモジュールを利用する場合は下記のようにジャンパしま
100105
その場合は、はんだを多めに使うか、別途フラックスを塗るとうまくジャンパができます。
101106

102107
### ProMicro
108+
103109
ピンヘッダを白い枠に当てはめるようにはんだづけし、そこにProMicroの裏面を上にしてはんだづけします。
104110

105111
![11](https://user-images.githubusercontent.com/736191/54487441-79cb9900-48d9-11e9-9317-e77c4c408a4f.jpg)
@@ -108,13 +114,15 @@ OLEDモジュールを利用する場合は下記のようにジャンパしま
108114
なおスプリングピンヘッダを利用する場合は [Helix のビルドガイド](https://github.com/MakotoKurauchi/helix/blob/master/Doc/buildguide_jp.md#pro-micro)を参考にしてください。
109115

110116
### OLEDモジュール
117+
111118
OLED用のピンソケットにピンヘッダを先に差し込み、その後からピンヘッダとOLEDモジュールをはんだづけします。
112119
このときOLEDモジュールが浮きやすいので指で押さえつけながら浮かないように気をつけます。
113120

114121
![13](https://user-images.githubusercontent.com/736191/54487443-7a642f80-48d9-11e9-818a-4913b8abe986.jpg)
115122
![14](https://user-images.githubusercontent.com/736191/54487445-7a642f80-48d9-11e9-9bb0-f753a5e4720b.jpg)
116123

117124
### 動作確認
125+
118126
ProMicroとOLEDモジュールを付けた段階で動作確認をすることをおすすめします(一番最後にやると問題の切り分けが難しくなる)。
119127

120128
動作確認をする場合は先に下記の「ファームウェア」の章を参考にしてcrkbd用のファームウェアをProMicroに入れてください(必ず両側に入れてください)。
@@ -124,6 +132,7 @@ ProMicroとOLEDモジュールを付けた段階で動作確認をすること
124132
![15](https://user-images.githubusercontent.com/736191/54487446-7a642f80-48d9-11e9-8bd2-2b413e3e080a.jpg)
125133

126134
### Kailh PCBソケット
135+
127136
裏面の両側のパッドにはんだを盛ります。後から追加するのが難しいので予め多めに盛ってください。
128137

129138
![16](https://user-images.githubusercontent.com/736191/54487447-7afcc600-48d9-11e9-91cb-edd541365180.jpg)
@@ -150,10 +159,12 @@ ProMicroとOLEDモジュールを付けた段階で動作確認をすること
150159
![20](https://user-images.githubusercontent.com/736191/54487451-7afcc600-48d9-11e9-8c90-2f2919bf9483.jpg)
151160

152161
## ファームウェア
162+
153163
下記を参照しファームウェアをProMicroに書き込みます。\
154-
https://github.com/foostan/crkbd/blob/master/doc/firmware_jp.md
164+
<https://github.com/foostan/crkbd/blob/master/doc/firmware_jp.md>
155165

156166
## LED(オプション)
167+
157168
SK6812MINIを取り付けていきます。
158169

159170
SK6812MINIは非常に熱に弱く、簡単に壊れます。

corne-cherry/doc/v2/buildguide_tilting_tenting_plate_jp.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1-
# Build Guide Tilting/Tenting plate
1+
# Build Guide Tilting/Tenting plate
22

33
## 部品
4-
| 名前 || 備考 |
4+
5+
| 名前 || 備考 |
56
|:-|:-|:-|
67
| 完成済み Corne Cherry | 1セット | Corne Chocolate / 3mmのトッププレート は非対応 |
78
| ミドルプレート 3mm | 2枚 | |

corne-cherry/doc/v3/buildguide_jp.md

+12-5
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,11 @@
33
こちらは Corne Cherry v3 のビルドガイドになります。
44
[Corne Cherry v2 はこちら](https://github.com/foostan/crkbd/blob/master/corne-cherry/doc/v2/buildguide_jp.md)
55

6-
76
## 部品
7+
88
### 必須
9-
| 名前 || 備考 |
9+
10+
| 名前 || 備考 |
1011
|:-|:-|:-|
1112
| PCB | 1セット | |
1213
| トッププレート | 2枚 | |
@@ -27,6 +28,7 @@
2728
| Micro USBケーブル | 1本 | |
2829

2930
### オプション
31+
3032
| 名前 || 備考 |
3133
|:-|:-|:-|
3234
| OLEDモジュール | 2枚 | |
@@ -36,8 +38,9 @@
3638
| WS2812B | 12個 | Undergrow 用 LEDs |
3739

3840
## 事前準備
41+
3942
ファームウェアを自分でビルドする場合は環境を整備するのに時間がかかるのではじめに取り掛かっておくことをおすすめします。\
40-
詳しくは https://github.com/foostan/crkbd/blob/master/doc/firmware_jp.md を参照してください。
43+
詳しくは <https://github.com/foostan/crkbd/blob/master/doc/firmware_jp.md> を参照してください。
4144

4245
## 確認
4346

@@ -56,6 +59,7 @@ PCBは製造の都合上フレームが付いた状態となっています。
5659
![confirm_remove_frame](assets/confirm_remove_frame.jpg)
5760

5861
## 組み立て
62+
5963
### ダイオード
6064

6165
SMD部品のダイオードのはんだづけを行います。
@@ -134,7 +138,6 @@ SK6812MINI に比べて壊れにくいですが、はんだごての熱を直接
134138

135139
![build_led_backlight](assets/build_led_backlight.jpg)
136140

137-
138141
左右合わせて計42個はんだづけして SK6812MINI-E は完了です。
139142

140143
![build_led_back_overview](assets/build_led_back_overview.jpg)
@@ -148,6 +151,7 @@ SK6812MINI に比べて壊れにくいですが、はんだごての熱を直接
148151
ずれやすい部品なので、手で部品を抑えながらはんだづけするか、マスキングテープ等で固定してからはんだづけするときれいに付きます。
149152

150153
### ProMicro
154+
151155
ProMicroを下記のような向きではんだ付けします
152156

153157
![build_promicro](assets/build_promicro.jpg)
@@ -158,16 +162,19 @@ ProMicroを下記のような向きではんだ付けします
158162
![build_promicro_conthrough](assets/build_promicro_conthrough.jpg)
159163

160164
### OLEDモジュール
165+
161166
OLED用のピンソケットにピンヘッダを先に差し込み、その後からピンヘッダとOLEDモジュールをはんだづけします。
162167
このときOLEDモジュールが浮きやすいので指で押さえつけながら浮かないように気をつけます。
163168

164169
![build_oled](assets/build_oled.jpg)
165170

166171
## ファームウェア
172+
167173
下記を参照しファームウェアをProMicroに書き込みます。\
168-
https://github.com/foostan/crkbd/blob/master/doc/firmware_jp.md
174+
<https://github.com/foostan/crkbd/blob/master/doc/firmware_jp.md>
169175

170176
### 動作確認
177+
171178
ProMicroとOLEDモジュールを付けた段階で動作確認をすることをおすすめします。
172179
一番最後にやると問題の切り分けが難しくなります。
173180

corne-chocolate/doc/buildguide_en.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ This is the build guide for Corne Chocolate.
77

88
### Required
99

10-
| Name | Number | Remarks |
10+
| Name | Number | Remarks |
1111
|:-|:-|:-|
1212
| PCB | 2 pieces | |
1313
| Top plate | 2 pieces | |
@@ -37,6 +37,7 @@ This is the build guide for Corne Chocolate.
3737
| SK6812MINI | 54 | 42 for backlight, 12 for under-glow |
3838

3939
## Preparation
40+
4041
If you build the firmware yourself, it will take some time to set up the environment, so it's best to start at the beginning. \
4142
For more information, please see https://github.com/foostan/crkbd/blob/master/doc/firmware_en.md.
4243

@@ -252,8 +253,9 @@ because it looks better.
252253
![](https://user-images.githubusercontent.com/736191/52534914-00e19a80-2d8b-11e9-8005-7e0b157e09e4.png)
253254

254255
## Firmware
256+
255257
See below to flash the firmware to the ProMicro. \
256-
https://github.com/foostan/crkbd/blob/master/doc/firmware_en.md
258+
<https://github.com/foostan/crkbd/blob/master/doc/firmware_en.md>
257259

258260
This is the end.
259261

corne-chocolate/doc/buildguide_jp.md

+12-8
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,10 @@
44
[Corne Cherry はこちら](https://github.com/foostan/crkbd/blob/master/corne-cherry/doc/buildguide_jp.md)
55

66
## 部品
7+
78
### 必須
8-
| 名前 || 備考 |
9+
10+
| 名前 || 備考 |
911
|:-|:-|:-|
1012
| PCB | 2枚 | |
1113
| トッププレート | 2枚 | |
@@ -29,13 +31,15 @@
2931
| Micro USBケーブル | 1本 | |
3032

3133
### オプション
34+
3235
| 名前 || 備考 |
3336
|:-|:-|:-|
3437
| SK6812MINI | 54個 | 上向き実装 42個、下向き実装 12個 |
3538

3639
## 事前準備
40+
3741
ファームウェアを自分でビルドする場合は環境を整備するのに時間がかかるのではじめに取り掛かっておくことをおすすめします。\
38-
詳しくは https://github.com/foostan/crkbd/blob/master/doc/firmware_jp.md を参照してください。
42+
詳しくは <https://github.com/foostan/crkbd/blob/master/doc/firmware_jp.md> を参照してください。
3943

4044
## 実装
4145

@@ -45,7 +49,6 @@ PCBはリバーシブルになっているので、最初にどちらを左用/
4549

4650
### ダイオード
4751

48-
4952
チップ部品のダイオードのはんだづけを行います。
5053
Corne Cherryではどちらの面に取り付けるかは自由でしたが、Corne Chocolateでは**必ず裏面に取り付けてください**
5154
表面に実装するとトッププレートと干渉してしまいます。
@@ -55,7 +58,7 @@ Corne Cherryではどちらの面に取り付けるかは自由でしたが、Co
5558

5659
![02](https://user-images.githubusercontent.com/736191/52534466-1b187a00-2d85-11e9-8ce3-bb13067a1b29.png)
5760

58-
ダイオードの向きは次のとおりです。チップ部品の「|||」印が、ダイオードマーク「|◁」の「|」の方に向けるように取り付けます(画像はCorne Cherryから転記)。
61+
ダイオードの向きは次のとおりです。チップ部品の「|||」印が、ダイオードマーク「|◁」の「|」の方に向けるように取り付けます(画像はCorne Cherryから転記)。
5962

6063
![03](https://user-images.githubusercontent.com/736191/54487560-cb285800-48da-11e9-9e1e-aafaacf5723c.jpg)
6164

@@ -88,6 +91,7 @@ Corne Cherryではどちらの面に取り付けるかは自由でしたが、Co
8891
![09](https://user-images.githubusercontent.com/736191/52534621-40a68300-2d87-11e9-9749-14459d2b1eac.png)
8992

9093
### OLEDモジュールのためのジャンパ
94+
9195
OLEDモジュールを利用する場合は下記のようにジャンパします。
9296
なお**表面のみジャンパしてください**
9397

@@ -118,6 +122,7 @@ OLED用のピンソケットにピンヘッダを先に差し込み、その後
118122
![16](https://user-images.githubusercontent.com/736191/52534722-67b18480-2d88-11e9-94d0-e3c899bcc020.png)
119123

120124
### 動作確認
125+
121126
ProMicroとOLEDモジュールを付けた段階で動作確認をすることをおすすめします(一番最後にやると問題の切り分けが難しくなる)。
122127

123128
動作確認をする場合は先に下記の「ファームウェア」の章を参考にしてcrkbd用のファームウェアをProMicroに入れてください(必ず両側に入れてください)。
@@ -162,6 +167,7 @@ LEDは4つずつはんだづけを行いますが、一度に4つ行わず
162167
![25](https://user-images.githubusercontent.com/736191/52534811-85331e00-2d89-11e9-9752-c40ffab23419.png)
163168

164169
### Kailh PCBソケット
170+
165171
![26](https://user-images.githubusercontent.com/736191/52534832-be6b8e00-2d89-11e9-82e6-be53dd82bf59.png)
166172

167173
裏面の両側のパッドにはんだを盛ります。後から追加するのが難しいので予め多めに盛ってください。
@@ -191,12 +197,10 @@ LEDは4つずつはんだづけを行いますが、一度に4つ行わず
191197
![33](https://user-images.githubusercontent.com/736191/52534914-00e19a80-2d8b-11e9-8005-7e0b157e09e4.png)
192198

193199
## ファームウェア
200+
194201
下記を参照しファームウェアをProMicroに書き込みます。\
195-
https://github.com/foostan/crkbd/blob/master/doc/firmware_jp.md
202+
<https://github.com/foostan/crkbd/blob/master/doc/firmware_jp.md>
196203

197204
以上で完成です。
198205

199206
![34](https://user-images.githubusercontent.com/736191/52534969-be6c8d80-2d8b-11e9-82ac-a2cd09ab96d1.png)
200-
201-
202-

0 commit comments

Comments
 (0)