Markdown-reflow to prevent long lines

This commit is contained in:
hoijui
2021-04-17 15:09:15 +02:00
parent 600c36e2a0
commit ff167b689c
3 changed files with 209 additions and 61 deletions

View File

@@ -1,7 +1,8 @@
# Build Guide
This is the build guide for Corne Chocolate.
[Click here for Corne Cherry](https://github.com/foostan/crkbd/blob/master/corne-cherry/doc/buildguide_en.md).
[Click here for Corne Cherry](
https://github.com/foostan/crkbd/blob/master/corne-cherry/doc/buildguide_en.md).
## Parts
@@ -38,8 +39,11 @@ This is the build guide for Corne Chocolate.
## Preparation
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. \
For more information, please see https://github.com/foostan/crkbd/blob/master/doc/firmware_en.md.
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. \
For more information,
please see <https://github.com/foostan/crkbd/blob/master/doc/firmware_en.md>.
## Building
@@ -59,13 +63,15 @@ Mounting on the front will interfere with the top plate.
Since the diodes are very small,
it is easier to work with tweezers and inverted tweezers.
Since the **mounting orientation of the diode is crucial**,
it is possible to proceed smoothly if you arrange the columns and rows to be mounted in advance,
it is possible to proceed smoothly
if you arrange the columns and rows to be mounted in advance,
as shown in the following photo.
![](https://user-images.githubusercontent.com/736191/52534466-1b187a00-2d85-11e9-8ce3-bb13067a1b29.png)
The orientation of the diode is as follows.
Attach the chip component so that the "|||" mark on the diode is facing the "|" of the diode mark "| ◁" on the PCB (image from Corne Cherry).
Attach the chip component so that the "|||" mark on the diode is facing the "|"
of the diode mark "|◁" on the PCB (image from Corne Cherry).
![](https://user-images.githubusercontent.com/736191/54487560-cb285800-48da-11e9-9e1e-aafaacf5723c.jpg)
@@ -76,7 +82,8 @@ 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 so that you can hold the SMD part firmly without applying force,
it is recommended that you use inverted tweezers
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,
@@ -127,7 +134,8 @@ If so, you cna fix the jumper by applying more solder or separate flux.
![](https://user-images.githubusercontent.com/736191/52534637-99761b80-2d87-11e9-958a-c6ca836a7936.png)
Solder the pin headers to the white frame and solder the Pro Micro with back side up.
Solder the pin headers to the white frame
and solder the Pro Micro with back side up.
![](https://user-images.githubusercontent.com/736191/52534641-a266ed00-2d87-11e9-8dcb-832b90556ac2.png)
![](https://user-images.githubusercontent.com/736191/52534643-aa269180-2d87-11e9-9c05-67924d235968.png)
@@ -142,7 +150,8 @@ please refer to the [Helix Build Guide](https://github.com/MakotoKurauchi/helix/
Insert the pin header into the OLED pin socket first,
then solder the pin header and the OLED module.
At this time,
make sure that he OLED module sits tightly on the socket while holding it down with your finger,
make sure that he OLED module sits tightly on the socket
while holding it down with your finger,
because it tends to stick out easily.
![](https://user-images.githubusercontent.com/736191/52534720-5e281c80-2d88-11e9-9b76-164d9b63692f.png)
@@ -150,16 +159,21 @@ because it tends to stick out easily.
### Operation check
We recommend that you check the operation at the stage where the Pro Micro and OLED modules are attached (it is difficult to isolate the problem at the end).
We recommend that you check the operation at the stage
where the Pro Micro and OLED modules are attached
(it is difficult to isolate the problem at the end).
Before checking the correct operation,
flash the crkbd firmware to the Pro Micro by referring to the [Firmware](#firmware) section below
flash the crkbd firmware to the Pro Micro
by referring to the [Firmware](#firmware) section below
(be sure to insert it on both sides).
Operation confirmation is performed by connecting the left hand side to a PC with Micro USB
Operation confirmation is performed
by connecting the left hand side to a PC with Micro USB
and connecting the left hand side and the right hand side with a TRS cable.
Since there may be a defect such as a jack,
make sure to connect the left and right instead of one by one before checking the operation.
make sure to connect the left and right
instead of one by one before checking the operation.
If you have done this correctly,
short-circuit the pad to attach the PCB socket with tweezers,
and the key pressed on the OLED module will be displayed.
@@ -176,12 +190,14 @@ so if you are worried about mounting it,
we recommend that you skip this chapter and complete it first.
SK6812MINI is very heat sensitive and breaks easily.
We recommend using a soldering iron with a temperature control function and operating at a temperature of about 220°C to 270°C.
We recommend using a soldering iron with a temperature control function
and operating at a temperature of about 220°C to 270°C.
Even if the temperature is set that low,
the LED will be damaged if the iron is left on it for a long time,
so try to solder as quickly as possible.
Solder four LEDs at a time,
but we recommend soldering two at a time instead of four at a time to prevent the LED temperature from rising,
but we recommend soldering two at a time instead of four at a time
to prevent the LED temperature from rising,
as this will make it less likely to overheat.
First, check the mounting position.
@@ -194,13 +210,15 @@ Below is the location to attach the LED (image from Corne Cherry).
![](https://user-images.githubusercontent.com/736191/46822569-cc52d780-cdc6-11e8-9602-f6265a2c876d.png)
For LEDs 1 to 6,
solder the part so that the black part circled below is on the bottom and the silk mark indicated by the arrow is on the top.
solder the part so that the black part circled below is on the bottom
and the silk mark indicated by the arrow is on the top.
Note that the direction changes between 1 - 3 and 4 - 5.
![](https://user-images.githubusercontent.com/736191/46822428-6d8d5e00-cdc6-11e8-8858-06e8dbdb8ee8.png)
For 7 - 27,
perform soldering so that the largest pad surrounded by a circle and the silk mark indicated by an arrow are adjacent to each other,
perform soldering so that the largest pad surrounded by a circle
and the silk mark indicated by an arrow are adjacent to each other,
as shown below.
![](https://user-images.githubusercontent.com/736191/46822434-6ebe8b00-cdc6-11e8-9686-69ac88bb4389.png)