Merge pull request foostan#99 from hoijui/cleanup2

Cleanup Markdown, mostly syntax and line-length

README.md

@@ -1,19 +1,19 @@
 # Corne keyboard
 
-The Corne keyboard is a split keyboard with 3x6 column staggered keys and 3 thumb keys,
-based on [Helix](https://github.com/MakotoKurauchi/helix).
+The Corne keyboard is a split keyboard with 3x6 column staggered keys
+and 3 thumb keys, based on [Helix](https://github.com/MakotoKurauchi/helix).
 Crkbd stands for Corne Keyboard.
 
 ## Lineup
 
 - corne-classic([JP](corne-classic/doc/buildguide_jp.md)/[EN](corne-classic/doc/buildguide_en.md)):
-    Corne for Cherry MX switches
+  Corne for Cherry MX switches
 - corne-cherry([JP](corne-cherry/doc/buildguide_jp.md)) ([tilting, JP](corne-cherry/doc/v2/buildguide_tilting_tenting_plate_jp.md)):
-    Hotswappable Corne for Cherry MX switches by kailh PCB sockets.
+  Hotswappable Corne for Cherry MX switches by kailh PCB sockets.
 - corne-chocolate([JP](corne-chocolate/doc/buildguide_jp.md)/[EN](corne-chocolate/doc/buildguide_en.md)):
-    Hotswappable Corne for Chocolate switches using Kailh PCB hot-swap sockets.
+  Hotswappable Corne for Chocolate switches using Kailh PCB hot-swap sockets.
 - corne-light([JP](corne-light/doc/buildguide_jp.md)):
-    Light-weight Corne (Easy build with a simple PCB).
+  Light-weight Corne (Easy build with a simple PCB).
 
 ## Photos
 

corne-cherry/doc/v2/buildguide_jp.md

@@ -4,8 +4,10 @@
 [Corne Cherry v3 はこちら](https://github.com/foostan/crkbd/blob/master/corne-cherry/doc/v3/buildguide_jp.md)。
 
 ## 部品
+
 ### 必須
-| 名前 | 数 | 備考 | 
+
+| 名前 | 数 | 備考 |
 |:-|:-|:-|
 | PCB | 2枚 | |
 | トッププレート | 2枚 | |
@@ -29,15 +31,17 @@
 | Micro USBケーブル | 1本 | |
 
 ### オプション
+
 | 名前 | 数 | 備考 |
 |:-|:-|:-|
 | SK6812MINI | 54個 | 上向き実装 42個、下向き実装 12個 |
 
 ![01](https://user-images.githubusercontent.com/736191/54487431-789a6c00-48d9-11e9-9390-a8510b19ba34.jpg)
 
 ## 事前準備
+
 ファームウェアを自分でビルドする場合は環境を整備するのに時間がかかるのではじめに取り掛かっておくことをおすすめします。\
-詳しくは https://github.com/foostan/crkbd/blob/master/doc/firmware_jp.md を参照してください。
+詳しくは <https://github.com/foostan/crkbd/blob/master/doc/firmware_jp.md> を参照してください。
 
 ## 実装
 
@@ -56,7 +60,7 @@ PCBはリバーシブルになっているので、最初にどちらを左用/
 
 ![03](https://user-images.githubusercontent.com/736191/54487433-789a6c00-48d9-11e9-991b-92264a793ec9.jpg)
 
-ダイオードの向きは次のとおりです。チップ部品の「|||」印が、ダイオードマーク「|◁」の「|」の方に向けるように取り付けます。 
+ダイオードの向きは次のとおりです。チップ部品の「|||」印が、ダイオードマーク「|◁」の「|」の方に向けるように取り付けます。
 
 ![04](https://user-images.githubusercontent.com/736191/54487434-79330280-48d9-11e9-82be-a9d98803a417.jpg)
 
@@ -89,6 +93,7 @@ PCBはリバーシブルになっているので、最初にどちらを左用/
 ![09](https://user-images.githubusercontent.com/736191/54487439-79cb9900-48d9-11e9-9a57-80697fa8b484.jpg)
 
 ### OLEDモジュールのためのジャンパとピンソケット
+
 OLEDモジュールを利用する場合は下記のようにジャンパします。
 なお**表面のみジャンパしてください**。
 
@@ -100,6 +105,7 @@ OLEDモジュールを利用する場合は下記のようにジャンパしま
 その場合は、はんだを多めに使うか、別途フラックスを塗るとうまくジャンパができます。
 
 ### ProMicro
+
 ピンヘッダを白い枠に当てはめるようにはんだづけし、そこにProMicroの裏面を上にしてはんだづけします。
 
 ![11](https://user-images.githubusercontent.com/736191/54487441-79cb9900-48d9-11e9-9317-e77c4c408a4f.jpg)
@@ -108,13 +114,15 @@ OLEDモジュールを利用する場合は下記のようにジャンパしま
 なおスプリングピンヘッダを利用する場合は [Helix のビルドガイド](https://github.com/MakotoKurauchi/helix/blob/master/Doc/buildguide_jp.md#pro-micro)を参考にしてください。
 
 ### OLEDモジュール
+
 OLED用のピンソケットにピンヘッダを先に差し込み、その後からピンヘッダとOLEDモジュールをはんだづけします。
 このときOLEDモジュールが浮きやすいので指で押さえつけながら浮かないように気をつけます。
 
 ![13](https://user-images.githubusercontent.com/736191/54487443-7a642f80-48d9-11e9-818a-4913b8abe986.jpg)
 ![14](https://user-images.githubusercontent.com/736191/54487445-7a642f80-48d9-11e9-9bb0-f753a5e4720b.jpg)
 
 ### 動作確認
+
 ProMicroとOLEDモジュールを付けた段階で動作確認をすることをおすすめします(一番最後にやると問題の切り分けが難しくなる)。
 
 動作確認をする場合は先に下記の「ファームウェア」の章を参考にしてcrkbd用のファームウェアをProMicroに入れてください（必ず両側に入れてください）。
@@ -124,6 +132,7 @@ ProMicroとOLEDモジュールを付けた段階で動作確認をすること
 ![15](https://user-images.githubusercontent.com/736191/54487446-7a642f80-48d9-11e9-8bd2-2b413e3e080a.jpg)
 
 ### Kailh PCBソケット
+
 裏面の両側のパッドにはんだを盛ります。後から追加するのが難しいので予め多めに盛ってください。
 
 ![16](https://user-images.githubusercontent.com/736191/54487447-7afcc600-48d9-11e9-91cb-edd541365180.jpg)
@@ -150,10 +159,12 @@ ProMicroとOLEDモジュールを付けた段階で動作確認をすること
 ![20](https://user-images.githubusercontent.com/736191/54487451-7afcc600-48d9-11e9-8c90-2f2919bf9483.jpg)
 
 ## ファームウェア
+
 下記を参照しファームウェアをProMicroに書き込みます。\
-https://github.com/foostan/crkbd/blob/master/doc/firmware_jp.md
+<https://github.com/foostan/crkbd/blob/master/doc/firmware_jp.md>
 
 ## LED（オプション）
+
 SK6812MINIを取り付けていきます。
 
 SK6812MINIは非常に熱に弱く、簡単に壊れます。

corne-cherry/doc/v2/buildguide_tilting_tenting_plate_jp.md

@@ -1,7 +1,8 @@
-# Build Guide Tilting/Tenting plate 
+# Build Guide Tilting/Tenting plate
 
 ## 部品
-| 名前 | 数 | 備考 | 
+
+| 名前 | 数 | 備考 |
 |:-|:-|:-|
 | 完成済み Corne Cherry | 1セット | Corne Chocolate / 3mmのトッププレート は非対応 |
 | ミドルプレート 3mm | 2枚 | |

corne-cherry/doc/v3/buildguide_jp.md

@@ -3,10 +3,11 @@
 こちらは Corne Cherry v3 のビルドガイドになります。
 [Corne Cherry v2 はこちら](https://github.com/foostan/crkbd/blob/master/corne-cherry/doc/v2/buildguide_jp.md)。
 
-
 ## 部品
+
 ### 必須
-| 名前 | 数 | 備考 | 
+
+| 名前 | 数 | 備考 |
 |:-|:-|:-|
 | PCB | 1セット | |
 | トッププレート | 2枚 | |
@@ -27,6 +28,7 @@
 | Micro USBケーブル | 1本 | |
 
 ### オプション
+
 | 名前 | 数 | 備考 |
 |:-|:-|:-|
 | OLEDモジュール | 2枚 | |
@@ -36,8 +38,9 @@
 | WS2812B | 12個 | Undergrow 用 LEDs |
 
 ## 事前準備
+
 ファームウェアを自分でビルドする場合は環境を整備するのに時間がかかるのではじめに取り掛かっておくことをおすすめします。\
-詳しくは https://github.com/foostan/crkbd/blob/master/doc/firmware_jp.md を参照してください。
+詳しくは <https://github.com/foostan/crkbd/blob/master/doc/firmware_jp.md> を参照してください。
 
 ## 確認
 
@@ -56,6 +59,7 @@ PCBは製造の都合上フレームが付いた状態となっています。
 ![confirm_remove_frame](assets/confirm_remove_frame.jpg)
 
 ## 組み立て
+
 ### ダイオード
 
 SMD部品のダイオードのはんだづけを行います。
@@ -134,7 +138,6 @@ SK6812MINI に比べて壊れにくいですが、はんだごての熱を直接
 
 ![build_led_backlight](assets/build_led_backlight.jpg)
 
-
 左右合わせて計42個はんだづけして SK6812MINI-E は完了です。
 
 ![build_led_back_overview](assets/build_led_back_overview.jpg)
@@ -148,6 +151,7 @@ SK6812MINI に比べて壊れにくいですが、はんだごての熱を直接
 ずれやすい部品なので、手で部品を抑えながらはんだづけするか、マスキングテープ等で固定してからはんだづけするときれいに付きます。
 
 ### ProMicro
+
 ProMicroを下記のような向きではんだ付けします
 
 ![build_promicro](assets/build_promicro.jpg)
@@ -158,16 +162,19 @@ ProMicroを下記のような向きではんだ付けします
 ![build_promicro_conthrough](assets/build_promicro_conthrough.jpg)
 
 ### OLEDモジュール
+
 OLED用のピンソケットにピンヘッダを先に差し込み、その後からピンヘッダとOLEDモジュールをはんだづけします。
 このときOLEDモジュールが浮きやすいので指で押さえつけながら浮かないように気をつけます。
 
 ![build_oled](assets/build_oled.jpg)
 
 ## ファームウェア
+
 下記を参照しファームウェアをProMicroに書き込みます。\
-https://github.com/foostan/crkbd/blob/master/doc/firmware_jp.md
+<https://github.com/foostan/crkbd/blob/master/doc/firmware_jp.md>
 
 ### 動作確認
+
 ProMicroとOLEDモジュールを付けた段階で動作確認をすることをおすすめします。
 一番最後にやると問題の切り分けが難しくなります。
 

corne-chocolate/doc/buildguide_en.md

@@ -1,13 +1,14 @@
 # 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
 
 ### Required
 
-| Name | Number | Remarks | 
+| Name | Number | Remarks |
 |:-|:-|:-|
 | PCB | 2 pieces | |
 | Top plate | 2 pieces | |
@@ -37,8 +38,12 @@ 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.
+
+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
 
@@ -58,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)
 
@@ -75,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,
@@ -126,13 +134,14 @@ 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)
 
 When using the spring pin header,
-please refer to the [Helix Build Guide](https://github.com/MakotoKurauchi/helix/blob/master/Doc/buildguide_jp.md#pro-micro).
+please refer to the [Helix Build Guide](https://github.com/MakotoKurauchi/helix/blob/master/Doc/buildguide_en.md#pro-micro).
 
 ### OLED module
 
@@ -141,24 +150,30 @@ 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)
 ![](https://user-images.githubusercontent.com/736191/52534722-67b18480-2d88-11e9-94d0-e3c899bcc020.png)
 
 ### 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.
@@ -175,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.
@@ -193,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)
@@ -252,8 +271,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.