Add README

This commit is contained in:
foostan 2024-03-31 10:12:53 +09:00
parent c3fdc3edc6
commit 8cd4bc42cb
No known key found for this signature in database
GPG Key ID: 5717998CB8742205

31
readme.md Normal file
View File

@ -0,0 +1,31 @@
# KBD firmware
## How to build
Get src of `qmk/qmk_firmware` and `vial-kb/vial-qmk` first
```sh
make git-submodule
```
### VIA
```sh
make qmk-clean
kb=crkbd make qmk-init
kb=crkbd kr=rev4/standard km=via make qmk-compile
```
A built data will be stored on `keyboards/crkbd/qmk/qmk_firmware/.build`\
Please change `kb`, `kr` and `km` when build other.
### Vial
```sh
make vial-qmk-clean
kb=crkbd make vial-qmk-init
kb=crkbd kr=rev4/standard km=vial make vial-qmk-compile
```
A built data will be stored on `keyboards/crkbd/vial-kb/vial-qmk/.build`\
Please change `kb`, `kr` and `km` when build other.
### All clean and build
```sh
make git-submodule
```