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

Improves MarkDown standards conformity

Browse Source
This commit is contained in:
hoijui
2021-04-17 13:34:24 +02:00
parent 894984e4bd
commit 94676e66a0
11 changed files with 120 additions and 58 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
corne-chocolate/doc/buildguide_en.md
View File

@@ -7,7 +7,7 @@ This is the build guide for Corne Chocolate.
### Required
| Name | Number | Remarks |
| Name | Number | Remarks |
|:-|:-|:-|
| PCB | 2 pieces | |
| Top plate | 2 pieces | |
@@ -37,6 +37,7 @@ This is the build guide for Corne Chocolate.
| SK6812MINI | 54 | 42 for backlight, 12 for under-glow |
## 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.
@@ -252,8 +253,9 @@ because it looks better.
![](https://user-images.githubusercontent.com/736191/52534914-00e19a80-2d8b-11e9-8005-7e0b157e09e4.png)
## Firmware
See below to flash the firmware to the ProMicro. \
https://github.com/foostan/crkbd/blob/master/doc/firmware_en.md
<https://github.com/foostan/crkbd/blob/master/doc/firmware_en.md>
This is the end.

20
corne-chocolate/doc/buildguide_jp.md
View File

@@ -4,8 +4,10 @@
[Corne Cherry はこちら](https://github.com/foostan/crkbd/blob/master/corne-cherry/doc/buildguide_jp.md)。
## 部品
### 必須
| 名前 | 数 | 備考 |
| 名前 | 数 | 備考 |
|:-|:-|:-|
| PCB | 2枚 | |
| トッププレート | 2枚 | |
@@ -29,13 +31,15 @@
| Micro USBケーブル | 1本 | |
### オプション
| 名前 | 数 | 備考 |
|:-|:-|:-|
| SK6812MINI | 54個 | 上向き実装 42個、下向き実装 12個 |
## 事前準備
ファームウェアを自分でビルドする場合は環境を整備するのに時間がかかるのではじめに取り掛かっておくことをおすすめします。\
詳しくは https://github.com/foostan/crkbd/blob/master/doc/firmware_jp.md を参照してください。
詳しくは <https://github.com/foostan/crkbd/blob/master/doc/firmware_jp.md> を参照してください。
## 実装
@@ -45,7 +49,6 @@ PCBはリバーシブルになっているので、最初にどちらを左用/
### ダイオード
チップ部品のダイオードのはんだづけを行います。
Corne Cherryではどちらの面に取り付けるかは自由でしたが、Corne Chocolateでは**必ず裏面に取り付けてください**。
表面に実装するとトッププレートと干渉してしまいます。
@@ -55,7 +58,7 @@ Corne Cherryではどちらの面に取り付けるかは自由でしたが、Co
![02](https://user-images.githubusercontent.com/736191/52534466-1b187a00-2d85-11e9-8ce3-bb13067a1b29.png)
ダイオードの向きは次のとおりです。チップ部品の「|||」印が、ダイオードマーク「|◁」の「|」の方に向けるように取り付けます(画像はCorne Cherryから転記)。
ダイオードの向きは次のとおりです。チップ部品の「|||」印が、ダイオードマーク「|◁」の「|」の方に向けるように取り付けます(画像はCorne Cherryから転記)。
![03](https://user-images.githubusercontent.com/736191/54487560-cb285800-48da-11e9-9e1e-aafaacf5723c.jpg)
@@ -88,6 +91,7 @@ Corne Cherryではどちらの面に取り付けるかは自由でしたが、Co
![09](https://user-images.githubusercontent.com/736191/52534621-40a68300-2d87-11e9-9749-14459d2b1eac.png)
### OLEDモジュールのためのジャンパ
OLEDモジュールを利用する場合は下記のようにジャンパします。
なお**表面のみジャンパしてください**。
@@ -118,6 +122,7 @@ OLED用のピンソケットにピンヘッダを先に差し込み、その後
![16](https://user-images.githubusercontent.com/736191/52534722-67b18480-2d88-11e9-94d0-e3c899bcc020.png)
### 動作確認
ProMicroとOLEDモジュールを付けた段階で動作確認をすることをおすすめします(一番最後にやると問題の切り分けが難しくなる)。
動作確認をする場合は先に下記の「ファームウェア」の章を参考にしてcrkbd用のファームウェアをProMicroに入れてください（必ず両側に入れてください）。
@@ -162,6 +167,7 @@ LEDは４つずつはんだづけを行いますが、一度に４つ行わず
![25](https://user-images.githubusercontent.com/736191/52534811-85331e00-2d89-11e9-9752-c40ffab23419.png)
### Kailh PCBソケット
![26](https://user-images.githubusercontent.com/736191/52534832-be6b8e00-2d89-11e9-82e6-be53dd82bf59.png)
裏面の両側のパッドにはんだを盛ります。後から追加するのが難しいので予め多めに盛ってください。
@@ -191,12 +197,10 @@ LEDは４つずつはんだづけを行いますが、一度に４つ行わず
![33](https://user-images.githubusercontent.com/736191/52534914-00e19a80-2d8b-11e9-8005-7e0b157e09e4.png)
## ファームウェア
下記を参照しファームウェアをProMicroに書き込みます。\
https://github.com/foostan/crkbd/blob/master/doc/firmware_jp.md
<https://github.com/foostan/crkbd/blob/master/doc/firmware_jp.md>
以上で完成です。
![34](https://user-images.githubusercontent.com/736191/52534969-be6c8d80-2d8b-11e9-82ac-a2cd09ab96d1.png)