Unifies instructions a bit, and improves grammar and wording
This commit is contained in:
hoijui
parent
e0b911e8b3
commit
378fd86ac7
|
|
@ -1,8 +1,8 @@
|
|||
# Build Guide
|
||||
|
||||
This is the Corne Cherry build guide.
|
||||
The build guide differs depending on the version,
|
||||
The build guide differs depending on the version of your board,
|
||||
so please choose your own from the following.
|
||||
|
||||
- [v2 build guide](https://github.com/foostan/crkbd/blob/master/corne-cherry/doc/v2/buildguide_en.md)
|
||||
- [v3 build guide](https://github.com/foostan/crkbd/blob/master/corne-cherry/doc/v3/buildguide_en.md)
|
||||
- [v3 build guide](https://github.com/foostan/crkbd/blob/master/corne-cherry/doc/v3/buildguide_en.md)
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
# Build Guide
|
||||
|
||||
This is the build guide for Corne Cherry v2.
|
||||
[Corne Cherry v3 build guide](
|
||||
[Click here for the Corne Cherry v3 build guide](
|
||||
https://github.com/foostan/crkbd/blob/master/corne-cherry/doc/v3/buildguide_en.md).
|
||||
|
||||
## Parts
|
||||
|
|
@ -88,20 +88,21 @@ 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 be aware of attaching parts.
|
||||
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.
|
||||
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.
|
||||
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.
|
||||
|
||||
|
|
@ -142,8 +143,8 @@ and then solder it with the back side of the Pro Micro facing up.
|
|||
|
||||
|
||||
|
||||
If you want to use the spring pin header,
|
||||
please refer to [Helix Build Guide](
|
||||
If you want to use spring-loaded pin headers,
|
||||
please refer to the [Helix Build Guide](
|
||||
https://github.com/MakotoKurauchi/helix/blob/master/Doc/buildguide_en.md#pro-micro).
|
||||
|
||||
### OLED module
|
||||
|
|
@ -164,10 +165,12 @@ It is recommended to check the operation when ProMicro and OLED module are attac
|
|||
To check the operation, first insert the firmware for crkbd into ProMicro
|
||||
by referring to the "Firmware" chapter below (be sure to insert it on both sides).
|
||||
|
||||
To check the operation, connect the left hand side to the PC with MicroUSB
|
||||
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 TRS 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.
|
||||
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.
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
# Build Guide
|
||||
|
||||
This is the build guide for Corne Cherry v3.
|
||||
[Click here for Corne Cherry v2](
|
||||
[Click here for the Corne Cherry v2 build guide](
|
||||
https://github.com/foostan/crkbd/blob/master/corne-cherry/doc/v2/buildguide_en.md).
|
||||
|
||||
## Parts
|
||||
|
|
@ -41,10 +41,10 @@ https://github.com/foostan/crkbd/blob/master/corne-cherry/doc/v2/buildguide_en.m
|
|||
## 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.
|
||||
it will take some time to set up the environment,
|
||||
so it's best to start at the beginning. \
|
||||
For more information,
|
||||
please see <https://github.com/foostan/crkbd/blob/master/doc/firmware_en.md>.
|
||||
|
||||
## Verification
|
||||
|
||||
|
|
@ -57,7 +57,8 @@ 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 etc. to make it easier to remove.
|
||||
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,
|
||||
|
|
@ -74,7 +75,7 @@ Since SMD parts are very small,
|
|||
it is convenient to have tweezers and counter-acting tweezers.
|
||||
|
||||
**The diode has a fixed mounting direction**,
|
||||
and solder it so that the "|" mark on the part faces the "|" on the diode mark "|◁".
|
||||
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.
|
||||
|
||||
|
||||
|
|
@ -88,13 +89,14 @@ 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 be aware of attaching parts.
|
||||
At this time,
|
||||
it is recommended to use [reverse-action tweezers](https://www.alimed.com/_resources/cache/images/product/70895A_850x480-pad.jpg),
|
||||
so that you can hold the SMD part firmly without applying force,
|
||||
and concentrate on alignment and soldering instead.
|
||||
Also, if the soldering iron is too hot or the solder is touched too long,
|
||||
the flux contained in the solder may evaporate and form an undesirable pile solder,
|
||||
but since it can be repaired later,
|
||||
so at this point you should only care about attaching parts.
|
||||
It's okay.
|
||||
|
||||
|
||||
|
|
@ -106,13 +108,15 @@ 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
|
||||
Then solder the other pin.
|
||||
Be careful not to apply too much solder,
|
||||
as a small amount is sufficient.
|
||||
If you have applied too much,
|
||||
you can remove it with a suction pump, 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,
|
||||
additional soldering is performed, and if it is a heap,
|
||||
apply flux from above and heat it to clean it.
|
||||
|
||||
|
||||
|
|
@ -191,10 +195,11 @@ 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](
|
||||
If you use spring-loaded pin headers (e.g. Conthrough),
|
||||
you do not need to solder the back side.
|
||||
Please refer to the [Helix Build Guide](
|
||||
https://github.com/MakotoKurauchi/helix/blob/master/Doc/buildguide_en.md#pro-micro)
|
||||
for details on how to use Consul.
|
||||
for details on how to use spring-loaded pin headers.
|
||||
|
||||
|
||||
|
||||
|
|
@ -207,7 +212,7 @@ so be careful not to float it while pressing it with your finger.
|
|||
|
||||
|
||||
|
||||
## Firmware
|
||||
### Firmware
|
||||
|
||||
Write the firmware to ProMicro by referring to the following. \
|
||||
<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. \
|
|||
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,
|
||||
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.
|
||||
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.
|
||||
|
|
@ -242,7 +249,7 @@ The PCB socket is completed by soldering a total of 42 left and right.
|
|||
|
||||
### OLED protective plate
|
||||
|
||||
Install the OLED protective plate with M2 9mm spacers and M2 screws.
|
||||
Attach the OLED protective plate with M2 9mm spacers and M2 screws.
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
# Build Guide
|
||||
|
||||
This is the build guide for Corne Chocolate.
|
||||
[Click here for Corne Cherry](
|
||||
[Click here for the Corne Cherry build guide](
|
||||
https://github.com/foostan/crkbd/blob/master/corne-cherry/doc/buildguide_en.md).
|
||||
|
||||
## Parts
|
||||
|
|
@ -82,21 +82,23 @@ First put solder only on the right side of the pad.
|
|||
|
||||
Next, solder one of the diodes by melting the solder you already put on the board.
|
||||
At this time,
|
||||
it is recommended that you use inverted tweezers
|
||||
it is recommended to use [reverse-action tweezers](https://www.alimed.com/_resources/cache/images/product/70895A_850x480-pad.jpg),
|
||||
so that you can hold the SMD part firmly without applying force,
|
||||
and concentrate on alignment and soldering instead.
|
||||
Also, if the soldering iron is too hot or the solder is touched too long,
|
||||
the flux contained in the solder may evaporate and a solder pile may be formed,
|
||||
the flux contained in the solder may evaporate and form an undesirable pile solder,
|
||||
but since it can be repaired later,
|
||||
at this point just be aware of attaching parts;
|
||||
so at this point you should only care about attaching parts.
|
||||
It's okay.
|
||||
|
||||
|
||||
|
||||
Then solder the other pin.
|
||||
Be careful not to apply too much solder because a small amount is sufficient.
|
||||
Be careful not to apply too much solder,
|
||||
as a small amount is sufficient.
|
||||
If you have applied too much,
|
||||
you can remove it with a suction pump or scoop it with a soldering iron.
|
||||
you can remove it with a suction pump, blotting wire
|
||||
or by scooping it with a soldering iron.
|
||||
|
||||
|
||||
|
||||
|
|
@ -140,8 +142,9 @@ and solder the Pro Micro with back side up.
|
|||
|
||||
|
||||
|
||||
When using the spring pin header,
|
||||
please refer to the [Helix Build Guide](https://github.com/MakotoKurauchi/helix/blob/master/Doc/buildguide_en.md#pro-micro).
|
||||
When using the spring-loaded pin headers,
|
||||
please refer to the [Helix Build Guide](
|
||||
https://github.com/MakotoKurauchi/helix/blob/master/Doc/buildguide_en.md#pro-micro).
|
||||
|
||||
### OLED module
|
||||
|
||||
|
|
|
|||
|
|
@ -165,7 +165,8 @@ Two methods are introduced here.
|
|||
|
||||
#### Using Spring Loaded Header
|
||||
|
||||
Refer to [Helix Buildguide](https://github.com/MakotoKurauchi/helix/blob/master/Doc/buildguide_en.md#pro-micro)
|
||||
Refer to the [Helix build guide](
|
||||
https://github.com/MakotoKurauchi/helix/blob/master/Doc/buildguide_en.md#pro-micro)
|
||||
|
||||
ProMicro kit with spring loaded headers is available at Yusha-Kobo
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
# Build Guide
|
||||
|
||||
This is the Corne Light build guide.
|
||||
The build guide differs depending on the version,
|
||||
The build guide differs depending on the version of your board,
|
||||
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)
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# Build Guide
|
||||
|
||||
This is the Corne Light build guide.
|
||||
This is the Corne Light v1 build guide.
|
||||
|
||||
## Parts
|
||||
|
||||
|
|
@ -113,7 +113,8 @@ This is the Corne Light build guide.
|
|||
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.
|
||||
See <https://github.com/foostan/crkbd/blob/master/doc/firmware_en.md>
|
||||
for more information.
|
||||
|
||||
## Implementation
|
||||
|
||||
|
|
@ -184,7 +185,7 @@ https://github.com/MakotoKurauchi/helix/blob/master/Doc/buildguide_en.md#pro-mic
|
|||
|
||||
|
||||
|
||||
### Write firmware
|
||||
### Firmware
|
||||
|
||||
Write the firmware to ProMicro by referring to the following. \
|
||||
<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. \
|
|||
|
||||
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.
|
||||
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.
|
||||
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.
|
||||
|
|
|
|||
|
|
@ -105,7 +105,8 @@ 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.
|
||||
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.
|
||||
|
||||
|
|
@ -138,10 +139,11 @@ 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](
|
||||
If you use spring-loaded pin headers (e.g. Conthrough),
|
||||
you do not need to solder the back side.
|
||||
Please refer to the [Helix Build Guide](
|
||||
https://github.com/MakotoKurauchi/helix/blob/master/Doc/buildguide_en.md#pro-micro)
|
||||
for details on how to use Consul.
|
||||
for details on how to use spring-loaded pin headers.
|
||||
|
||||
|
||||
|
||||
|
|
@ -164,7 +166,8 @@ Write the firmware to ProMicro by referring to the following. \
|
|||
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,
|
||||
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
|
||||
|
|
@ -183,7 +186,7 @@ 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.
|
||||
Attach the OLED protective plate with M2 9mm spacers and M2 screws.
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue