Skip to content

Instantly share code, notes, and snippets.

@takashicompany
Last active March 14, 2022 11:04
Show Gist options
  • Save takashicompany/b2a8beca5d66366614745e4cb9ad24db to your computer and use it in GitHub Desktop.
Save takashicompany/b2a8beca5d66366614745e4cb9ad24db to your computer and use it in GitHub Desktop.
# チェックリスト
## QMK Firmwire
[ガイドライン](https://docs.qmk.fm/#/ja/hardware_keyboard_guidelines?id=qmk-%E3%82%AD%E3%83%BC%E3%83%9C%E3%83%BC%E3%83%89%E3%82%AC%E3%82%A4%E3%83%89%E3%83%A9%E3%82%A4%E3%83%B3)
- [ ] [./util/new_keyboard.sh](https://qiita.com/mizuhof/items/0c34308c2d57c9345f3a#%E3%82%AA%E3%83%AA%E3%82%B8%E3%83%8A%E3%83%AB%E3%82%AD%E3%83%BC%E3%83%9C%E3%83%BC%E3%83%89%E3%81%AE%E3%83%95%E3%82%A1%E3%83%BC%E3%83%A0%E3%82%A6%E3%82%A7%E3%82%A2%E3%82%92%E4%BD%9C%E6%88%90%E3%81%99%E3%82%8B)でフォルダを作る
- [ ] ファームウェアの作成
- [ ] PRODUCT_IDの決定
- [ ] [Keyboard Layout Editorでinfo.json用のレイアウトを作る](https://salicylic-acid3.hatenablog.com/entry/qmk-configurator#%E8%A8%AD%E8%A8%88%E8%80%85%E5%90%91%E3%81%91QMK-Configurator%E3%81%AB%E3%83%97%E3%83%AB%E3%83%AA%E3%82%AF%E3%81%99%E3%82%8B)
- [ ] [info.jsonの作成](https://docs.qmk.fm/#/ja/reference_info_json)
- [コンバーター](https://qmk.fm/converter/)
- [ ] [info.jsonの確認](https://skyhigh-works.hatenablog.com/entry/2021/04/07/192925)
- [ ] [キーマップのreadme.mdを用意する](https://docs.qmk.fm/#/ja/documentation_templates?id=keyboard-readmemd-template)
- [ ] [キーボードのreadme.mdを用意する](https://docs.qmk.fm/#/ja/documentation_templates?id=%e3%82%ad%e3%83%bc%e3%83%9c%e3%83%bc%e3%83%89-readmemd-%e3%83%86%e3%83%b3%e3%83%97%e3%83%ac%e3%83%bc%e3%83%88)
- [ ] [プルリクエストのチェックリストを確認](https://docs.qmk.fm/#/ja/pr_checklist?id=%e3%82%ad%e3%83%bc%e3%83%9c%e3%83%bc%e3%83%89%e3%81%ae-pr)
- [ ] プルリクエストを作る
## QMK Configurator対応
- [ ] [QMK Configurator用のキーマップを作成する](https://salicylic-acid3.hatenablog.com/entry/qmk-configurator#%E3%82%AD%E3%83%BC%E3%83%9E%E3%83%83%E3%83%97%E3%82%92%E4%BD%9C%E6%88%90%E3%81%99%E3%82%8B)
- [ ] [プルリクエストを出す](https://github.com/qmk/qmk_configurator)
## VIA
https://salicylic-acid3.hatenablog.com/entry/via-support
- [ ] [VENDER_IDの決定](https://caniusevia.com/docs/configuring_qmk/#change-vendor_id-product_id) `#define VENDOR_ID 0x7463 // tc = takashicompany`
- [ ] [VIA用のファームウェアの用意](https://salicylic-acid3.hatenablog.com/entry/via-support#VIA%E7%94%A8%E3%83%95%E3%82%A1%E3%83%BC%E3%83%A0%E3%82%A6%E3%82%A7%E3%82%A2%E3%81%AE%E4%BD%9C%E6%88%90%E6%96%B9%E6%B3%95)
- [ ] `keymaps/via/config.h`を用意してレイヤー数を設定する(`#define DYNAMIC_KEYMAP_LAYER_COUNT 8`)
- [ ] http://www.keyboard-layout-editor.com/ で[レイアウトの用意](https://salicylic-acid3.hatenablog.com/entry/via-support#KLE%E3%81%A7%E3%82%AD%E3%83%BC%E3%83%AC%E3%82%A4%E3%82%A2%E3%82%A6%E3%83%88%E3%82%92%E4%BD%9C%E6%88%90%E3%81%99%E3%82%8B)
- [ ] [VIA用のJSONの用意](https://salicylic-acid3.hatenablog.com/entry/via-support#VIA%E3%81%AB%E8%AA%AD%E3%81%BF%E8%BE%BC%E3%81%BE%E3%81%9B%E3%82%8Bjson%E3%83%95%E3%82%A1%E3%82%A4%E3%83%AB%E3%82%92%E4%BD%9C%E6%88%90%E3%81%99%E3%82%8B)
下記をコピペしてkeymaps以下にKLEで出力したものを貼ると良い
```
{
"name": "名前",
"vendorId": "0x0000,
"productId": "0x0000",
"lighting": "qmk_rgblight",
"matrix": {
"rows": 3,
"cols": 12
},
"layouts": {
"keymap": [
]
}
}
```
- [ ] [JSONのテスト](https://salicylic-acid3.hatenablog.com/entry/via-support#%E4%BD%9C%E3%81%A3%E3%81%9Fjson%E3%83%95%E3%82%A1%E3%82%A4%E3%83%AB%E3%81%AE%E3%83%86%E3%82%B9%E3%83%88%E3%82%92%E3%81%99%E3%82%8B)
## REMAP
VIA対応を済ませていることを前提とする
- [ ] エビデンスの用意 (ファームウェアのURLやプルリクエスト、開発ツイートなど)
- [ ] [Remapへの登録](https://salicylic-acid3.hatenablog.com/entry/remap-manual#Remap%E3%81%AB%E3%82%AD%E3%83%BC%E3%83%9E%E3%83%83%E3%83%97JSON%E3%81%AE%E7%99%BB%E9%8C%B2%E3%81%99%E3%82%8B%E6%96%B9%E6%B3%95%E3%81%AB%E3%81%A4%E3%81%84%E3%81%A6)
## ビルドログの用意
- [ ] 部品の一覧
- [ ] 組み立て方
- [ ] ファームウェア
## 委託販売
### [遊舎工房](https://yushakobo.jp/consignmen-sales/)
- [ ] サンプルキットの用意
- [ ] A5の商品紹介
- [ ] 説明文
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment