Brush up landing page and documents

README.md

@@ -1,49 +1,48 @@
-# keyball
+# Keyball Series
 
-Keyball is split keyboard has 100% track ball
+![Keyball61](./keyball61/doc/rev1/images/kb61_001.jpg)
 
-## Firmware build guide
+Keyball series is keyboard family which have 100% track ball.
 
-Keyball46 have separate firmwares for each of PCBs w/ trackball and w/o
-trackball.  You can build those with this commands in root of QMK firmware
-source tree.
+Keyboards in the family are:
 
-```console
-$ make keyball/rev1/ball:via
-$ make keyball/rev1/noball:via
-```
+* Available
+    * Keyball39: split + 39 keys + a track ball
+    * Keyball44: split + 44 keys + a track ball
+    * Keyball61: split + 61 keys + a track ball
+* Unavailable
+    * Keyball46 (first one!)
+    * One47
 
-You will get two files:
+## Where to Buy
 
-* `keyball_rev1_ball_via.hex` - Trackball PCB firmware with VIA support.
-* `keyball_rev1_noball_via.hex` - No trackball PCB firmware with VIA support.
+|Keyboard   |Yushakobo / 遊舎工房                       |Shirogane Lab / 白金ラボ                                   |
+|-----------|-------------------------------------------|-----------------------------------------------------------|
+|Keyball39  |<https://shop.yushakobo.jp/products/5357>  |<https://shirogane-lab.net/items/64b8f8693ee3fd0045280190> |
+|Keyball44  |N/A                                        |<https://shirogane-lab.net/items/64b7a006eb6dbe00346cd0c5> |
+|Keyball61  |<https://shop.yushakobo.jp/products/5358>  |<https://shirogane-lab.net/items/64b8ed191435c1002bc4cd30> |
 
-Write each firmwares to correct PCB's Pro Micro.
+## Build Guide
 
-In generally, you can build fimwares with this command.
+*   Keyball39:
+    [English/英語](/keyball39/doc/rev1/buildguide_en.md),
+    [日本語/Japanese (ピンヘッダ版)](./keyball39/doc/rev1/buildguide_jp.md),
+    [日本語/Japanese (コンスルー版)](./keyball39/doc/rev1/buildguide_jp_conth.md)
+*   Keyball44: ~~English/英語~~ (Sorry, unavailable),
+    [日本語/Japanese (ピンヘッダ版)](./keyball44/doc/rev1/buildguide_jp.md),
+    [日本語/Japanese (コンスルー版)](./keyball44/doc/rev1/buildguide_jp_conth.md)
+*   Keyball46:
+    [English/英語](./keyball46/doc/rev1/buildguide_en.md),
+    [日本語/Japanese](./keyball46/doc/rev1/buildguide_jp.md)
+*   Keyball61:
+    [English/英語](./keyball61/doc/rev1/buildguide_en.md),
+    [日本語/Japanese (ピンヘッダ版)](./keyball61/doc/rev1/buildguide_jp.md),
+    [日本語/Japanese (コンスルー版)](./keyball61/doc/rev1/buildguide_jp_conth.md)
 
-```console
-$ make keyball/rev1/ball:{YOUR_FAVORITE_KEYMAP}
-$ make keyball/rev1/noball:{YOUR_FAVORITE_KEYMAP}
-```
+## Firmware
 
-### Keyamaps
+See [document for firmware source code](./qmk_firmware/keyboards/keyball/readme.md).
 
-Keyball46 provides some keymaps as default:
+### Pre-compiled Firmwares
 
-* `via` - VIA support, trackball is on right side
-* `via_Left` - VIA support, trackball is on left side
-* `test` - Test for building/soldering Keyball46 (w/ right trackball)
-* `default` - Template for customized keymap (w/ right trackball)
-
-### Prerequirements to build firmware
-
-1. Checkout [QMK firmware source codes](https://github.com/qmk/qmk_firmware)
-2. Setup QMK correctly ([See also](https://beta.docs.qmk.fm/tutorial/newbs_getting_started))
-3. Copy `./qmk_firmware/keyboards/keyball/` directory in this repository to QMK firmware's dir as `{QMK_FIRMWARE_ROOT}/keyboards/keyball`.
-4. Build Keyball46 firmwares (See above section)
-
-    ```console
-    $ make keyball/rev1/ball:via
-    $ make keyball/rev1/noball:via
-    ```
+(TO BE DOCUMENTED)

keyball39/doc/rev1/buildguide_en.md

@@ -575,7 +575,7 @@ The latest firmware for Keyball39 is available at [Github repository](https://gi
    - The USB cable can be plugged in either left or right. However, since the keymap is written to the ProMicro on the side where the USB cable is plugged in, please review the keymap when replacing the cable for the first time.
    - There are Special keys for Keyball users as below list. It is located on Layer 3. These key codes can be used for switching Cursor action to Scroll or Changing CPI and Speed of Scroll.
 
-See [Special Keycode](./keycodes.md#english) also.
+See [Special Keycode](../../../qmk_firmware/keyboards/keyball/lib/keyball/keycodes.md#english) also.
 
 
 

keyball39/doc/rev1/buildguide_jp.md

@@ -590,7 +590,7 @@ Keyball39の最新ファームウェアは[Githubのリポジトリ](https://git
    - USBケーブルは左右どちらに差しても使用できます。ただしキーマップはUSBケーブルを差した側のProMicroへ書き込まれるため、初めて差し替えた場合にはキーマップを見直してください
    - Keyballシリーズ用に特別に用意されたキーコードがレイヤー３に配置されています。トラックボールをスクロールに変化させたり、カーソル速度やスクロール速度変更に使用できます。
 
-詳しくは [キーコード一覧](./keycodes.md#japanese) を参照してください。
+詳しくは [キーコード一覧](../../../qmk_firmware/keyboards/keyball/lib/keyball/keycodes.md#japanese) を参照してください。
 
 
 

keyball39/doc/rev1/buildguide_jp_conth.md

@@ -590,7 +590,7 @@ Keyball39の最新ファームウェアは[Githubのリポジトリ](https://git
    - USBケーブルは左右どちらに差しても使用できます。ただしキーマップはUSBケーブルを差した側のProMicroへ書き込まれるため、初めて差し替えた場合にはキーマップを見直してください
    - Keyballシリーズ用に特別に用意されたキーコードがレイヤー３に配置されています。トラックボールをスクロールに変化させたり、カーソル速度やスクロール速度変更に使用できます。
 
-詳しくは [キーコード一覧](./keycodes.md#japanese) を参照してください。
+詳しくは [キーコード一覧](../../../qmk_firmware/keyboards/keyball/lib/keyball/keycodes.md#japanese) を参照してください。
 
 
 

keyball44/doc/rev1/buildguide_jp.md

@@ -108,7 +108,7 @@ Keyball44 キットの同梱品は下記になります。
 |:-|:-|:-|
 | キーキャップ | ４４個 | 1u ４４個 |
 | ロープロファイルキーキャップ | ５個 | 親指ロープロ仕様のみ　1u ５個 |
-| [YS-SK6812MINI-E](https://shirogane-lab.com/products/%E3%83%95%E3%83%AB%E3%82%AB%E3%83%A9%E3%83%BC%E3%83%81%E3%83%83%E3%83%97led-sk6812mini-e) | ５９個 | ※SK6812MINIは使用できません |
+| [YS-SK6812MINI-E](https://shirogane-lab.net/items/64b8f178cbce52004b9555f9) | ５９個 | ※SK6812MINIは使用できません |
 
 <a id="anchor2"></a>
 ## ２．準備
@@ -207,7 +207,7 @@ PCBはリバーシブルになっているので、最初にどちらを左手
 
 <a id="anchor3-3"></a>
 ### 3-3．LED（オプション）のはんだ付け
-LED（YS-SK6812MINI-E）はオプションになります。キットには含まれませんので、[こちら](https://shirogane-lab.com/products/%E3%83%95%E3%83%AB%E3%82%AB%E3%83%A9%E3%83%BC%E3%83%81%E3%83%83%E3%83%97led-sk6812mini-e)等で入手してください。
+LED（YS-SK6812MINI-E）はオプションになります。キットには含まれませんので、[こちら](https://shirogane-lab.net/items/64b8f178cbce52004b9555f9)等で入手してください。
 
 左右で計５９個取り付け可能です。  
 
@@ -631,7 +631,7 @@ Keyball44の最新ファームウェアは[Githubのリポジトリ](https://git
    - USBケーブルは左右どちらに差しても使用できます。ただしキーマップはUSBケーブルを差した側のProMicroへ書き込まれるため、初めて差し替えた場合にはキーマップを見直してください
    - Keyballシリーズ用に特別に用意されたキーコードがレイヤー３に配置されています。トラックボールをスクロールに変化させたり、カーソル速度やスクロール速度変更に使用できます。
 
-詳しくは [キーコード一覧](./keycodes.md#japanese) を参照してください。
+詳しくは [キーコード一覧](../../../qmk_firmware/keyboards/keyball/lib/keyball/keycodes.md#japanese) を参照してください。
 
 
 

keyball44/doc/rev1/buildguide_jp_conth.md

@@ -108,7 +108,7 @@ Keyball44 キットの同梱品は下記になります。
 |:-|:-|:-|
 | キーキャップ | ４４個 | 1u ４４個 |
 | ロープロファイルキーキャップ | ５個 | 親指ロープロ仕様のみ　1u ５個 |
-| [YS-SK6812MINI-E](https://shirogane-lab.com/products/%E3%83%95%E3%83%AB%E3%82%AB%E3%83%A9%E3%83%BC%E3%83%81%E3%83%83%E3%83%97led-sk6812mini-e) | ５９個 | ※SK6812MINIは使用できません |
+| [YS-SK6812MINI-E](https://shirogane-lab.net/items/64b8f178cbce52004b9555f9) | ５９個 | ※SK6812MINIは使用できません |
 
 <a id="anchor2"></a>
 ## ２．準備
@@ -207,7 +207,7 @@ PCBはリバーシブルになっているので、最初にどちらを左手
 
 <a id="anchor3-3"></a>
 ### 3-3．LED（オプション）のはんだ付け
-LED（YS-SK6812MINI-E）はオプションになります。キットには含まれませんので、[こちら](https://shirogane-lab.com/products/%E3%83%95%E3%83%AB%E3%82%AB%E3%83%A9%E3%83%BC%E3%83%81%E3%83%83%E3%83%97led-sk6812mini-e)等で入手してください。
+LED（YS-SK6812MINI-E）はオプションになります。キットには含まれませんので、[こちら](https://shirogane-lab.net/items/64b8f178cbce52004b9555f9)等で入手してください。
 
 左右で計５９個取り付け可能です。  
 
@@ -625,7 +625,7 @@ Keyball44の最新ファームウェアは[Githubのリポジトリ](https://git
    - USBケーブルは左右どちらに差しても使用できます。ただしキーマップはUSBケーブルを差した側のProMicroへ書き込まれるため、初めて差し替えた場合にはキーマップを見直してください
    - Keyballシリーズ用に特別に用意されたキーコードがレイヤー３に配置されています。トラックボールをスクロールに変化させたり、カーソル速度やスクロール速度変更に使用できます。
 
-詳しくは [キーコード一覧](./keycodes.md#japanese) を参照してください。
+詳しくは [キーコード一覧](../../../qmk_firmware/keyboards/keyball/lib/keyball/keycodes.md#japanese) を参照してください。
 
 
 

keyball44/doc/rev1/buildguide_jp_sub.md

@@ -108,7 +108,7 @@ Keyball44 キットの同梱品は下記になります。
 |:-|:-|:-|
 | キーキャップ | ４４個 | 1u ４４個 |
 | ロープロファイルキーキャップ | ５個 | 親指ロープロ仕様のみ　1u ５個 |
-| [YS-SK6812MINI-E](https://shirogane-lab.com/products/%E3%83%95%E3%83%AB%E3%82%AB%E3%83%A9%E3%83%BC%E3%83%81%E3%83%83%E3%83%97led-sk6812mini-e) | ５９個 | ※SK6812MINIは使用できません |
+| [YS-SK6812MINI-E](https://shirogane-lab.net/items/64b8f178cbce52004b9555f9) | ５９個 | ※SK6812MINIは使用できません |
 
 <a id="anchor2"></a>
 ## ２．準備
@@ -207,7 +207,7 @@ PCBはリバーシブルになっているので、最初にどちらを左手
 
 <a id="anchor3-3"></a>
 ### 3-3．LED（オプション）のはんだ付け
-LED（YS-SK6812MINI-E）はオプションになります。キットには含まれませんので、[こちら](https://shirogane-lab.com/products/%E3%83%95%E3%83%AB%E3%82%AB%E3%83%A9%E3%83%BC%E3%83%81%E3%83%83%E3%83%97led-sk6812mini-e)等で入手してください。
+LED（YS-SK6812MINI-E）はオプションになります。キットには含まれませんので、[こちら](https://shirogane-lab.net/items/64b8f178cbce52004b9555f9)等で入手してください。
 
 左右で計５９個取り付け可能です。  
 
@@ -630,7 +630,7 @@ Keyball44の最新ファームウェアは[Githubのリポジトリ](https://git
    - USBケーブルは左右どちらに差しても使用できます。ただしキーマップはUSBケーブルを差した側のProMicroへ書き込まれるため、初めて差し替えた場合にはキーマップを見直してください
    - Keyballシリーズ用に特別に用意されたキーコードがレイヤー３に配置されています。トラックボールをスクロールに変化させたり、カーソル速度やスクロール速度変更に使用できます。
 
-詳しくは [キーコード一覧](./keycodes.md#japanese) を参照してください。
+詳しくは [キーコード一覧](../../../qmk_firmware/keyboards/keyball/lib/keyball/keycodes.md#japanese) を参照してください。
 
 
 

keyball46/doc/rev1/buildguide_en.md

@@ -599,7 +599,7 @@ The latest firmware for the Keyball46 is available in the [Github repository](ht
    - The USB cable can be plugged in either left or right. However, since the keymap is written to the ProMicro on the side where the USB cable is plugged in, please review the keymap when replacing the cable for the first time.
    - There are Special keys for Keyball users as below list. It is located on Layer 3. These key codes can be used for switching Cursor action to Scroll or Changing CPI and Speed of Scroll.
 
-See [Special Keycode](./keycodes.md#english) also.
+See [Special Keycode](../../../qmk_firmware/keyboards/keyball/lib/keyball/keycodes.md#english) also.
 
 
 

keyball46/doc/rev1/buildguide_jp.md

@@ -590,7 +590,7 @@ Keyball46の最新ファームウェアは[Githubのリポジトリ](https://git
    - USBケーブルは左右どちらに差しても使用できます。ただしキーマップはUSBケーブルを差した側のProMicroへ書き込まれるため、初めて差し替えた場合にはキーマップを見直してください
    - Keyballシリーズ用に特別に用意されたキーコードがレイヤー３に配置されています。トラックボールをスクロールに変化させたり、カーソル速度やスクロール速度変更に使用できます。
 
-詳しくは [キーコード一覧](./keycodes.md#japanese) を参照してください。
+詳しくは [キーコード一覧](../../../qmk_firmware/keyboards/keyball/lib/keyball/keycodes.md#japanese) を参照してください。