Kabbone/corne
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Unifies instructions a bit, and improves grammar and wording

Browse Source
This commit is contained in:
hoijui
2021-05-15 11:20:11 +02:00
parent e0b911e8b3
commit 378fd86ac7
8 changed files with 76 additions and 58 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
corne-light/doc/buildguide_en.md
View File

@@ -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)

13
corne-light/doc/v1/buildguide_en.md
View File

@@ -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
![assembly-promicro-oled](https://user-images.githubusercontent.com/736191/69554644-6e427d00-0fe5-11ea-8c6b-9aaa3d2c3f6c.JPG)
### 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.

15
corne-light/doc/v2/buildguide_low_edition_en.md
View File

@@ -105,7 +105,8 @@ and reheat the soldered part with a soldering iron to clean it.
![tips_building_smd_03](https://user-images.githubusercontent.com/736191/54487437-79330280-48d9-11e9-996d-a578e767c12c.jpg)
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
![build_promicro](assets/build_promicro.jpg)
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.
![build_promicro_conthrough](assets/build_promicro_conthrough.jpg)
@@ -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.
![build_oled_plate_front](assets/build_oled_plate_front.jpg)
![build_oled_plate_back](assets/build_oled_plate_back.jpg)