Add all missing English translations of MD documents
... using Google translate + manual MD syntax fixing
This commit is contained in:
hoijui
8
corne-light/doc/buildguide_en.md
Normal file
8
corne-light/doc/buildguide_en.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# Build Guide
|
||||
|
||||
This is the Corne Light build guide.
|
||||
The build guide differs depending on the version,
|
||||
so please choose your own from the following.
|
||||
|
||||
- [v1 build guide](https://github.com/foostan/crkbd/blob/master/corne-light/doc/v1/buildguide_en.md)
|
||||
- [v2 low-edition build guide](https://github.com/foostan/crkbd/blob/master/corne-light/doc/v2/buildguide_low_edition_en.md)
|
||||
244
corne-light/doc/v1/buildguide_en.md
Normal file
244
corne-light/doc/v1/buildguide_en.md
Normal file
@@ -0,0 +1,244 @@
|
||||
# Build Guide
|
||||
|
||||
This is the Corne Light build guide.
|
||||
|
||||
## Parts
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr> <td width = "30%"> Name </td> <td width = "15%"> Number </td> <td> Remarks </td> </tr>
|
||||
</header>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td> PCB </td>
|
||||
<td> 1 set </td>
|
||||
<td>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td> Top plate </td>
|
||||
<td> 2 sheets </td>
|
||||
<td>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td> Bottom plate </td>
|
||||
<td> 2 sheets </td>
|
||||
<td rowspan = "2">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td> ProMicro protective plate </td>
|
||||
<td> 2 sheets </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td> diode </td>
|
||||
<td> 42 </td>
|
||||
<td>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td> Spacer M2 7.5mm </td>
|
||||
<td> 10 </td>
|
||||
<td rowspan = "3">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td> Spacer M2 9mm </td>
|
||||
<td> 4 </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td> Screw M2 4mm </td>
|
||||
<td> 28 </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td> TRRS jack </td>
|
||||
<td> 2 </td>
|
||||
<td rowspan = "3">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td> Reset switch </td>
|
||||
<td> 2 </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td> Rubber feet </td>
|
||||
<td> 8 </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td> ProMicro (with conthrough) </td>
|
||||
<td> 2 </td>
|
||||
<td>
|
||||
<a href="https://yushakobo.jp/shop/promicro-spring-pinheader/"> https://yushakobo.jp/shop/promicro-spring-pinheader/ </a>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td> OLED module (with pin socket) </td>
|
||||
<td> 2 </td>
|
||||
<td>
|
||||
<a href="https://yushakobo.jp/shop/oled/"> https://yushakobo.jp/shop/oled/ </a>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td> key switch </td>
|
||||
<td> 42 </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td> keycap </td>
|
||||
<td> 42 </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td> TRRS cable </td>
|
||||
<td> 1 </td>
|
||||
<td> TRS cable is also acceptable </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td> USB cable </td>
|
||||
<td> 1 </td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## Advance preparation
|
||||
|
||||
If you build the firmware yourself,
|
||||
it takes time to prepare the environment,
|
||||
so it is recommended to start first. \
|
||||
See <https://github.com/foostan/crkbd/blob/master/doc/firmware_en.md> for more information.
|
||||
|
||||
## Implementation
|
||||
|
||||
### PCB disconnection
|
||||
|
||||
Check the front and back and separate the left and right PCBs
|
||||
(the photo is the front).
|
||||
|
||||
|
||||
|
||||
This is a jig for bending the legs of a diode.
|
||||
Separate it if necessary.
|
||||
|
||||
|
||||
|
||||
* Some versions do not have a jig.
|
||||
|
||||
### diode
|
||||
|
||||
First, bend the legs of the reed type diode.
|
||||
|
||||
* You can clean it by bending it one by one as shown in the picture,
|
||||
but it is more efficient to bend multiple pieces at the same time
|
||||
while connected to the tape.
|
||||
|
||||
|
||||
|
||||
Attach the diode with the bent leg to the specified position.
|
||||
|
||||
|
||||
|
||||
The diode has an orientation and is installed as shown in the photo.
|
||||
|
||||
* All the diodes to be attached are in the same orientation.
|
||||
|
||||
|
||||
|
||||
You can attach it neatly by fixing it with masking tape.
|
||||
|
||||
|
||||
|
||||
Solder from the back side.
|
||||
|
||||
|
||||
|
||||
If you are fixing with masking tape,
|
||||
cutting your legs to the limit like this will make soldering easier.
|
||||
|
||||
|
||||
|
||||
With 21 one-handed and two-handed he installs 42 diodes.
|
||||
|
||||
|
||||
|
||||
### TRRS jack, reset switch, pin socket
|
||||
|
||||
Install in the specified position.
|
||||
|
||||
* Install the right hand side in the same position
|
||||
(be careful of mistakes on the front and back).
|
||||
|
||||
|
||||
|
||||
### ProMicro, OLED module
|
||||
|
||||
Install his ProMicro and his OLED module by referring to the [Helix Build Guide](
|
||||
https://github.com/MakotoKurauchi/helix/blob/master/Doc/buildguide_en.md#pro-micro).
|
||||
|
||||
|
||||
|
||||
### Write firmware
|
||||
|
||||
Write the firmware to ProMicro by referring to the following. \
|
||||
<https://github.com/foostan/crkbd/blob/master/doc/firmware_en.md>
|
||||
|
||||
### Operation check
|
||||
|
||||
To check the operation,
|
||||
connect the left hand side to the PC with a USB cable,
|
||||
and connect the left hand side and the right hand side with a TRRS cable.
|
||||
Since there may be defects such as jacks,
|
||||
be sure to connect the left and right
|
||||
instead of one by one before checking the operation.
|
||||
|
||||
* Since the switch is not attached,
|
||||
check the operation with tweezers as shown in the photo.
|
||||
|
||||
|
||||
|
||||
### Top plate, key switch
|
||||
|
||||
Attach the key switch to the top plate as shown in the picture.
|
||||
|
||||
* Be careful of the direction of the key switch.
|
||||
|
||||
|
||||
|
||||
We recommend using a 3-pin key switch.
|
||||
|
||||
* Even when using 5 pins, the plastic legs can be separated to make 3 pins.
|
||||
|
||||
|
||||
|
||||
Solder so that there is no gap between the switch and the PCB.
|
||||
|
||||
|
||||
|
||||
|
||||
### ProMicro Protective Plate, Bottom Plate
|
||||
|
||||
Attach his ProMicro protective plate using an M2 9mm spacer.
|
||||
|
||||
|
||||
|
||||
Install the bottom plate using the M2 7.5mm spacer.
|
||||
|
||||
|
||||
|
||||
Attach the rubber feet to the four corners.
|
||||
|
||||
|
||||
|
||||
## Complete
|
||||
|
||||
Attach the keycap and you're done.
|
||||
|
||||
|
||||
|
||||
205
corne-light/doc/v2/buildguide_low_edition_en.md
Normal file
205
corne-light/doc/v2/buildguide_low_edition_en.md
Normal file
@@ -0,0 +1,205 @@
|
||||
# Build Guide
|
||||
|
||||
This is the build guide for Corne Light v2 Low edition.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Parts
|
||||
|
||||
### Required
|
||||
|
||||
| Name | Number | Remarks |
|
||||
|:-|:-|:-|
|
||||
| PCB | 1 set | |
|
||||
| Top plate (acrylic) 2mm | 2 sheets | |
|
||||
| Bottom foam | 2 sheets | Special foam is cut out with a special mold |
|
||||
| OLED protective plate | 2 sheets | |
|
||||
| ProMicro | 2 sheets | |
|
||||
| TRRS jack | 2 | |
|
||||
| Tact switch | 2 | |
|
||||
| Diodes | 42 | Recommended SMD Parts |
|
||||
| Key switches | 42 | Kailh Choc v1 or v2 recommended |
|
||||
| Keycaps | 42 pcs | 1u 40 pcs, 1.5u 2 pcs |
|
||||
| Spacer M2 9mm | 4 pieces | |
|
||||
| Screw M2 4mm | 8 screws | |
|
||||
| TRRS (4 poles) cable | 1 | TRS (3 poles) cable is also acceptable |
|
||||
| Micro USB cable | 1 | |
|
||||
|
||||
### Options
|
||||
|
||||
| Name | Number | Remarks |
|
||||
|:-|:-|:-|
|
||||
| OLED module | 2 sheets | |
|
||||
| Pin header for OLED module 4 series 1.5mm | 2 | |
|
||||
| 4 pin sockets for OLED module 2.5mm | 2 | |
|
||||
|
||||
## Advance preparation
|
||||
|
||||
If you build the firmware yourself,
|
||||
it takes time to prepare the environment,
|
||||
so it is recommended to start first. \
|
||||
See <https://github.com/foostan/crkbd/blob/master/doc/firmware_en.md>
|
||||
for more information.
|
||||
|
||||
## Verification
|
||||
|
||||
The PCB for Corne Light v2 is as follows.
|
||||
Make sure it is the same as your PCB.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
The PCB comes with a frame for manufacturing reasons.
|
||||
You can fold it by hand to remove it, but if it is difficult,
|
||||
make a cut in the joint \* with a cutter or similar,
|
||||
to make it easier to remove.
|
||||
In addition, the joint can be cleaned with a file.
|
||||
|
||||
\* *Joint part: There are a total of 8 parts,
|
||||
which are marked in red in the image below.*
|
||||
|
||||
|
||||
|
||||
## Assembly
|
||||
|
||||
### diode
|
||||
|
||||
Solder diodes for SMD components.
|
||||
Since SMD parts are very small,
|
||||
it is convenient to have tweezers and counter-acting tweezers.
|
||||
|
||||
**The diode has a fixed mounting direction**,
|
||||
so solder it so that the "|" mark on the part faces the "|" on the diode mark "|◁".
|
||||
In addition, Corne's PCB has all the same diode mounting orientations.
|
||||
|
||||
|
||||
|
||||
<details>
|
||||
<summary>TIPS: Tips for installing SMD parts</summary>
|
||||
|
||||
The trick is to attach the SMD parts, but first, as a spare solder,
|
||||
put the solder on only one side of the pad.
|
||||
|
||||
|
||||
|
||||
Next, solder one leg of the diode so that the spare solder melts.
|
||||
At this time, it is recommended to use reverse-action tweezers,
|
||||
because you can hold the chip parts firmly without exerting force
|
||||
and you can concentrate on alignment and soldering.
|
||||
Also, if the soldering iron is too hot or the solder is touched too much,
|
||||
the flux contained in the solder may evaporate and form a clean pile of solder,
|
||||
but it can be repaired later,
|
||||
so at this point you should only care about attaching parts.
|
||||
It's okay.
|
||||
|
||||
|
||||
|
||||
It is okay if the diode does not float when viewed from the side
|
||||
when one foot is attached.
|
||||
If it floats, press the diode with tweezers or your fingers
|
||||
and reheat the soldered part with a soldering iron to clean it.
|
||||
|
||||
|
||||
|
||||
Then solder the other one.
|
||||
Be careful not to apply too much, as a small amount of solder is sufficient.
|
||||
If you apply too much, you can remove it with a blotting wire
|
||||
or by scooping it with a soldering iron.
|
||||
|
||||
If the amount of solder on the preliminary solder side is small,
|
||||
additional soldering is performed, and if it is a mountain,
|
||||
apply flux from above and heat it to clean it.
|
||||
|
||||
|
||||
|
||||
</details>
|
||||
|
||||
The diode is completed by soldering 42 pieces in total on the left and right.
|
||||
|
||||
|
||||
|
||||
### TRRS jack, reset switch, pin socket for OLED
|
||||
|
||||
Solder the TRRS jack, reset switch (tact switch),
|
||||
and OLED pin socket as shown in the picture below.
|
||||
|
||||
|
||||
|
||||
Since it is a part that easily slips off,
|
||||
you can solder it while holding the part by hand,
|
||||
or fix it with masking tape and then solder it.
|
||||
|
||||
### ProMicro
|
||||
|
||||
Solder ProMicro in the following orientation
|
||||
|
||||
|
||||
|
||||
If you use Conthru, you do not need to solder the back side.
|
||||
Please refer to [Helix Build Guide](
|
||||
https://github.com/MakotoKurauchi/helix/blob/master/Doc/buildguide_en.md#pro-micro)
|
||||
for details on how to use Consul.
|
||||
|
||||
|
||||
|
||||
### OLED module
|
||||
|
||||
Insert the pin header into the pin socket for OLED first,
|
||||
and then solder the pin header and OLED module.
|
||||
At this time, the OLED module is easy to float,
|
||||
so be careful not to float it while pressing it with your finger.
|
||||
|
||||
|
||||
|
||||
### Firmware
|
||||
|
||||
Write the firmware to ProMicro by referring to the following. \
|
||||
<https://github.com/foostan/crkbd/blob/master/doc/firmware_en.md>
|
||||
|
||||
### Operation check
|
||||
|
||||
We recommend that you check the operation when the ProMicro and OLED module are attached.
|
||||
If you do it at the very end, it will be difficult to isolate the problem.
|
||||
|
||||
To check the operation, connect the left hand side to the PC with MicroUSB,
|
||||
and connect the left hand side and the right hand side with the TRRS cable.
|
||||
Since there may be defects such as jacks,
|
||||
be sure to connect the left and right instead of one by one
|
||||
before checking the operation.
|
||||
If it is done correctly so far,
|
||||
if you short the pad to attach the PCB socket with tweezers etc.,
|
||||
the key pressed on the OLED module will be displayed.
|
||||
|
||||
### Top plate, switch
|
||||
|
||||
After attaching the key switch to the top plate, solder the key switch.
|
||||
If you attach all the key switches to the top plate first,
|
||||
it will be more difficult to attach the switches to the board,
|
||||
so it is easier to attach only the end key switches first.
|
||||
|
||||
|
||||
### OLED protective plate
|
||||
|
||||
Attach his OLED protective plate with M2 9mm spacers and M2 screws.
|
||||
|
||||
|
||||
|
||||
|
||||
Especially for the screws on the back side,
|
||||
tighten them firmly to attach the bottom foam after this.
|
||||
|
||||
### Bottom form
|
||||
|
||||
Finally, paste the bottom form.
|
||||
This foam has an adhesive surface on one side
|
||||
and a non-slip surface on the other side.
|
||||
Stick the adhesive side firmly to the PCB.
|
||||
|
||||
|
||||
|
||||
That's it.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user