Skip to content

Commit 378fd86

Browse files
committed
Unifies instructions a bit, and improves grammar and wording
1 parent e0b911e commit 378fd86

8 files changed

Lines changed: 76 additions & 58 deletions

File tree

corne-cherry/doc/buildguide_en.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Build Guide
22

33
This is the Corne Cherry build guide.
4-
The build guide differs depending on the version,
4+
The build guide differs depending on the version of your board,
55
so please choose your own from the following.
66

77
- [v2 build guide](https://github.com/foostan/crkbd/blob/master/corne-cherry/doc/v2/buildguide_en.md)
8-
- [v3 build guide](https://github.com/foostan/crkbd/blob/master/corne-cherry/doc/v3/buildguide_en.md)
8+
- [v3 build guide](https://github.com/foostan/crkbd/blob/master/corne-cherry/doc/v3/buildguide_en.md)

corne-cherry/doc/v2/buildguide_en.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Build Guide
22

33
This is the build guide for Corne Cherry v2.
4-
[Corne Cherry v3 build guide](
4+
[Click here for the Corne Cherry v3 build guide](
55
https://github.com/foostan/crkbd/blob/master/corne-cherry/doc/v3/buildguide_en.md).
66

77
## Parts
@@ -88,20 +88,21 @@ and you can concentrate on alignment and soldering.
8888
Also, if the soldering iron is too hot or the solder is touched too much,
8989
the flux contained in the solder may evaporate and form a clean pile of solder,
9090
but it can be repaired later,
91-
so at this point you should only be aware of attaching parts.
91+
so at this point you should only care about attaching parts.
9292
It's okay.
9393

9494
![06](https://user-images.githubusercontent.com/736191/54487436-79330280-48d9-11e9-856e-f3f5b9f58414.jpg)
9595

9696
It is okay if the diode does not float when viewed from the side
9797
when one foot is attached.
98-
If it floats, press the diode with tweezers
99-
or your fingers and reheat the soldered part with a soldering iron to clean it.
98+
If it floats, press the diode with tweezers or your fingers
99+
and reheat the soldered part with a soldering iron to clean it.
100100

101101
![07](https://user-images.githubusercontent.com/736191/54487437-79330280-48d9-11e9-996d-a578e767c12c.jpg)
102102

103103
Then solder the other one.
104-
Be careful not to apply too much as a small amount of solder is sufficient.
104+
Be careful not to apply too much,
105+
as a small amount of solder is sufficient.
105106
If you apply too much, you can remove it with a blotting wire
106107
or by scooping it with a soldering iron.
107108

@@ -142,8 +143,8 @@ and then solder it with the back side of the Pro Micro facing up.
142143
![11](https://user-images.githubusercontent.com/736191/54487441-79cb9900-48d9-11e9-9317-e77c4c408a4f.jpg)
143144
![12](https://user-images.githubusercontent.com/736191/54487442-7a642f80-48d9-11e9-85f6-469d8beaa9c0.jpg)
144145

145-
If you want to use the spring pin header,
146-
please refer to [Helix Build Guide](
146+
If you want to use spring-loaded pin headers,
147+
please refer to the [Helix Build Guide](
147148
https://github.com/MakotoKurauchi/helix/blob/master/Doc/buildguide_en.md#pro-micro).
148149

149150
### OLED module
@@ -164,10 +165,12 @@ It is recommended to check the operation when ProMicro and OLED module are attac
164165
To check the operation, first insert the firmware for crkbd into ProMicro
165166
by referring to the "Firmware" chapter below (be sure to insert it on both sides).
166167

167-
To check the operation, connect the left hand side to the PC with MicroUSB
168+
To check the operation,
169+
connect the left hand side to the PC with MicroUSB,
168170
and connect the left hand side and the right hand side with the TRS cable.
169171
Since there may be defects such as jacks,
170-
be sure to connect the left and right instead of one by one before checking the operation.
172+
be sure to connect the left and right instead of one by one
173+
before checking the operation.
171174
If it is done correctly so far,
172175
if you short the pad to attach the PCB socket with tweezers etc.,
173176
the key pressed on the OLED module will be displayed.

corne-cherry/doc/v3/buildguide_en.md

Lines changed: 32 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Build Guide
22

33
This is the build guide for Corne Cherry v3.
4-
[Click here for Corne Cherry v2](
4+
[Click here for the Corne Cherry v2 build guide](
55
https://github.com/foostan/crkbd/blob/master/corne-cherry/doc/v2/buildguide_en.md).
66

77
## Parts
@@ -41,10 +41,10 @@ https://github.com/foostan/crkbd/blob/master/corne-cherry/doc/v2/buildguide_en.m
4141
## Advance preparation
4242

4343
If you build the firmware yourself,
44-
it takes time to prepare the environment,
45-
so it is recommended to start first. \
46-
See <https://github.com/foostan/crkbd/blob/master/doc/firmware_en.md>
47-
for more information.
44+
it will take some time to set up the environment,
45+
so it's best to start at the beginning. \
46+
For more information,
47+
please see <https://github.com/foostan/crkbd/blob/master/doc/firmware_en.md>.
4848

4949
## Verification
5050

@@ -57,7 +57,8 @@ Make sure it is the same as your PCB.
5757

5858
The PCB comes with a frame for manufacturing reasons.
5959
You can fold it by hand to remove it, but if it is difficult,
60-
make a cut in the joint \* with a cutter etc. to make it easier to remove.
60+
make a cut in the joint \* with a cutter or similar,
61+
to make it easier to remove.
6162
In addition, the joint can be cleaned with a file.
6263

6364
\* *Joint part: There are a total of 8 parts,
@@ -74,7 +75,7 @@ Since SMD parts are very small,
7475
it is convenient to have tweezers and counter-acting tweezers.
7576

7677
**The diode has a fixed mounting direction**,
77-
and solder it so that the "|" mark on the part faces the "|" on the diode mark "|◁".
78+
so solder it so that the "|" mark on the part faces the "|" on the diode mark "|◁".
7879
In addition, Corne's PCB has all the same diode mounting orientations.
7980

8081
![build_diode](assets/build_diode.jpg)
@@ -88,13 +89,14 @@ put the solder on only one side of the pad.
8889
![tips_building_smd_01](https://user-images.githubusercontent.com/736191/54487435-79330280-48d9-11e9-9138-525d8ee68144.jpg)
8990

9091
Next, solder one leg of the diode so that the spare solder melts.
91-
At this time, it is recommended to use reverse-action tweezers,
92-
because you can hold the chip parts firmly without exerting force
93-
and you can concentrate on alignment and soldering.
94-
Also, if the soldering iron is too hot or the solder is touched too much,
95-
the flux contained in the solder may evaporate and form a clean pile of solder,
96-
but it can be repaired later,
97-
so at this point you should only be aware of attaching parts.
92+
At this time,
93+
it is recommended to use [reverse-action tweezers](https://www.alimed.com/_resources/cache/images/product/70895A_850x480-pad.jpg),
94+
so that you can hold the SMD part firmly without applying force,
95+
and concentrate on alignment and soldering instead.
96+
Also, if the soldering iron is too hot or the solder is touched too long,
97+
the flux contained in the solder may evaporate and form an undesirable pile solder,
98+
but since it can be repaired later,
99+
so at this point you should only care about attaching parts.
98100
It's okay.
99101

100102
![tips_building_smd_02](https://user-images.githubusercontent.com/736191/54487436-79330280-48d9-11e9-856e-f3f5b9f58414.jpg)
@@ -106,13 +108,15 @@ and reheat the soldered part with a soldering iron to clean it.
106108

107109
![tips_building_smd_03](https://user-images.githubusercontent.com/736191/54487437-79330280-48d9-11e9-996d-a578e767c12c.jpg)
108110

109-
Then solder the other one. Be careful not to apply too much,
110-
as a small amount of solder is sufficient.
111-
If you apply too much, you can remove it with a blotting wire
111+
Then solder the other pin.
112+
Be careful not to apply too much solder,
113+
as a small amount is sufficient.
114+
If you have applied too much,
115+
you can remove it with a suction pump, blotting wire
112116
or by scooping it with a soldering iron.
113117

114118
If the amount of solder on the preliminary solder side is small,
115-
additional soldering is performed, and if it is a mountain,
119+
additional soldering is performed, and if it is a heap,
116120
apply flux from above and heat it to clean it.
117121

118122
![tips_building_smd_04](https://user-images.githubusercontent.com/736191/54487438-79cb9900-48d9-11e9-9280-dc72a2087307.jpg)
@@ -191,10 +195,11 @@ Solder ProMicro in the following orientation
191195

192196
![build_promicro](assets/build_promicro.jpg)
193197

194-
If you use Conthru, you do not need to solder the back side.
195-
Please refer to [Helix Build Guide](
198+
If you use spring-loaded pin headers (e.g. Conthrough),
199+
you do not need to solder the back side.
200+
Please refer to the [Helix Build Guide](
196201
https://github.com/MakotoKurauchi/helix/blob/master/Doc/buildguide_en.md#pro-micro)
197-
for details on how to use Consul.
202+
for details on how to use spring-loaded pin headers.
198203

199204
![build_promicro_conthrough](assets/build_promicro_conthrough.jpg)
200205

@@ -207,7 +212,7 @@ so be careful not to float it while pressing it with your finger.
207212

208213
![build_oled](assets/build_oled.jpg)
209214

210-
## Firmware
215+
### Firmware
211216

212217
Write the firmware to ProMicro by referring to the following. \
213218
<https://github.com/foostan/crkbd/blob/master/doc/firmware_en.md>
@@ -217,10 +222,12 @@ Write the firmware to ProMicro by referring to the following. \
217222
We recommend that you check the operation when the ProMicro and OLED module are attached.
218223
If you do it at the very end, it will be difficult to isolate the problem.
219224

220-
To check the operation, connect the left hand side to the PC with MicroUSB,
225+
To check the operation,
226+
connect the left hand side to the PC with MicroUSB,
221227
and connect the left hand side and the right hand side with the TRRS cable.
222228
Since there may be defects such as jacks,
223-
be sure to connect the left and right instead of one by one before checking the operation.
229+
be sure to connect the left and right instead of one by one
230+
before checking the operation.
224231
If it is done correctly so far,
225232
if you short the pad to attach the PCB socket with tweezers etc.,
226233
the key pressed on the OLED module will be displayed.
@@ -242,7 +249,7 @@ The PCB socket is completed by soldering a total of 42 left and right.
242249

243250
### OLED protective plate
244251

245-
Install the OLED protective plate with M2 9mm spacers and M2 screws.
252+
Attach the OLED protective plate with M2 9mm spacers and M2 screws.
246253

247254
![build_oled_plate_front](assets/build_oled_plate_front.jpg)
248255
![build_oled_plate_back](assets/build_oled_plate_back.jpg)

corne-chocolate/doc/buildguide_en.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Build Guide
22

33
This is the build guide for Corne Chocolate.
4-
[Click here for Corne Cherry](
4+
[Click here for the Corne Cherry build guide](
55
https://github.com/foostan/crkbd/blob/master/corne-cherry/doc/buildguide_en.md).
66

77
## Parts
@@ -82,21 +82,23 @@ First put solder only on the right side of the pad.
8282

8383
Next, solder one of the diodes by melting the solder you already put on the board.
8484
At this time,
85-
it is recommended that you use inverted tweezers
85+
it is recommended to use [reverse-action tweezers](https://www.alimed.com/_resources/cache/images/product/70895A_850x480-pad.jpg),
8686
so that you can hold the SMD part firmly without applying force,
8787
and concentrate on alignment and soldering instead.
8888
Also, if the soldering iron is too hot or the solder is touched too long,
89-
the flux contained in the solder may evaporate and a solder pile may be formed,
89+
the flux contained in the solder may evaporate and form an undesirable pile solder,
9090
but since it can be repaired later,
91-
at this point just be aware of attaching parts;
91+
so at this point you should only care about attaching parts.
9292
It's okay.
9393

9494
![](https://user-images.githubusercontent.com/736191/52534541-320b9c00-2d86-11e9-982c-45ec7f7b7741.png)
9595

9696
Then solder the other pin.
97-
Be careful not to apply too much solder because a small amount is sufficient.
97+
Be careful not to apply too much solder,
98+
as a small amount is sufficient.
9899
If you have applied too much,
99-
you can remove it with a suction pump or scoop it with a soldering iron.
100+
you can remove it with a suction pump, blotting wire
101+
or by scooping it with a soldering iron.
100102

101103
![](https://user-images.githubusercontent.com/736191/52534553-56677880-2d86-11e9-872e-ea374c8f6824.png)
102104

@@ -140,8 +142,9 @@ and solder the Pro Micro with back side up.
140142
![](https://user-images.githubusercontent.com/736191/52534641-a266ed00-2d87-11e9-8dcb-832b90556ac2.png)
141143
![](https://user-images.githubusercontent.com/736191/52534643-aa269180-2d87-11e9-9c05-67924d235968.png)
142144

143-
When using the spring pin header,
144-
please refer to the [Helix Build Guide](https://github.com/MakotoKurauchi/helix/blob/master/Doc/buildguide_en.md#pro-micro).
145+
When using the spring-loaded pin headers,
146+
please refer to the [Helix Build Guide](
147+
https://github.com/MakotoKurauchi/helix/blob/master/Doc/buildguide_en.md#pro-micro).
145148

146149
### OLED module
147150

corne-classic/doc/buildguide_en.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,8 @@ Two methods are introduced here.
165165

166166
#### Using Spring Loaded Header
167167

168-
Refer to [Helix Buildguide](https://github.com/MakotoKurauchi/helix/blob/master/Doc/buildguide_en.md#pro-micro)
168+
Refer to the [Helix build guide](
169+
https://github.com/MakotoKurauchi/helix/blob/master/Doc/buildguide_en.md#pro-micro)
169170

170171
ProMicro kit with spring loaded headers is available at Yusha-Kobo
171172

corne-light/doc/buildguide_en.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Build Guide
22

33
This is the Corne Light build guide.
4-
The build guide differs depending on the version,
4+
The build guide differs depending on the version of your board,
55
so please choose your own from the following.
66

77
- [v1 build guide](https://github.com/foostan/crkbd/blob/master/corne-light/doc/v1/buildguide_en.md)

corne-light/doc/v1/buildguide_en.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Build Guide
22

3-
This is the Corne Light build guide.
3+
This is the Corne Light v1 build guide.
44

55
## Parts
66

@@ -113,7 +113,8 @@ This is the Corne Light build guide.
113113
If you build the firmware yourself,
114114
it takes time to prepare the environment,
115115
so it is recommended to start first. \
116-
See <https://github.com/foostan/crkbd/blob/master/doc/firmware_en.md> for more information.
116+
See <https://github.com/foostan/crkbd/blob/master/doc/firmware_en.md>
117+
for more information.
117118

118119
## Implementation
119120

@@ -184,7 +185,7 @@ https://github.com/MakotoKurauchi/helix/blob/master/Doc/buildguide_en.md#pro-mic
184185

185186
![assembly-promicro-oled](https://user-images.githubusercontent.com/736191/69554644-6e427d00-0fe5-11ea-8c6b-9aaa3d2c3f6c.JPG)
186187

187-
### Write firmware
188+
### Firmware
188189

189190
Write the firmware to ProMicro by referring to the following. \
190191
<https://github.com/foostan/crkbd/blob/master/doc/firmware_en.md>
@@ -193,10 +194,10 @@ Write the firmware to ProMicro by referring to the following. \
193194

194195
To check the operation,
195196
connect the left hand side to the PC with a USB cable,
196-
and connect the left hand side and the right hand side with a TRRS cable.
197+
and connect the left hand side and the right hand side with the TRRS cable.
197198
Since there may be defects such as jacks,
198-
be sure to connect the left and right
199-
instead of one by one before checking the operation.
199+
be sure to connect the left and right instead of one by one
200+
before checking the operation.
200201

201202
* Since the switch is not attached,
202203
check the operation with tweezers as shown in the photo.

corne-light/doc/v2/buildguide_low_edition_en.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,8 @@ and reheat the soldered part with a soldering iron to clean it.
105105
![tips_building_smd_03](https://user-images.githubusercontent.com/736191/54487437-79330280-48d9-11e9-996d-a578e767c12c.jpg)
106106

107107
Then solder the other one.
108-
Be careful not to apply too much, as a small amount of solder is sufficient.
108+
Be careful not to apply too much,
109+
as a small amount of solder is sufficient.
109110
If you apply too much, you can remove it with a blotting wire
110111
or by scooping it with a soldering iron.
111112

@@ -138,10 +139,11 @@ Solder ProMicro in the following orientation
138139

139140
![build_promicro](assets/build_promicro.jpg)
140141

141-
If you use Conthru, you do not need to solder the back side.
142-
Please refer to [Helix Build Guide](
142+
If you use spring-loaded pin headers (e.g. Conthrough),
143+
you do not need to solder the back side.
144+
Please refer to the [Helix Build Guide](
143145
https://github.com/MakotoKurauchi/helix/blob/master/Doc/buildguide_en.md#pro-micro)
144-
for details on how to use Consul.
146+
for details on how to use spring-loaded pin headers.
145147

146148
![build_promicro_conthrough](assets/build_promicro_conthrough.jpg)
147149

@@ -164,7 +166,8 @@ Write the firmware to ProMicro by referring to the following. \
164166
We recommend that you check the operation when the ProMicro and OLED module are attached.
165167
If you do it at the very end, it will be difficult to isolate the problem.
166168

167-
To check the operation, connect the left hand side to the PC with MicroUSB,
169+
To check the operation,
170+
connect the left hand side to the PC with MicroUSB,
168171
and connect the left hand side and the right hand side with the TRRS cable.
169172
Since there may be defects such as jacks,
170173
be sure to connect the left and right instead of one by one
@@ -183,7 +186,7 @@ so it is easier to attach only the end key switches first.
183186

184187
### OLED protective plate
185188

186-
Attach his OLED protective plate with M2 9mm spacers and M2 screws.
189+
Attach the OLED protective plate with M2 9mm spacers and M2 screws.
187190

188191
![build_oled_plate_front](assets/build_oled_plate_front.jpg)
189192
![build_oled_plate_back](assets/build_oled_plate_back.jpg)

0 commit comments

Comments
 (0)