sdoh55/kbd_firmware
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update readme

Browse Source
This commit is contained in:
foostan 2024-03-31 10:26:52 +09:00
parent 8cd4bc42cb
commit 987b528af2
No known key found for this signature in database
GPG Key ID: 5717998CB8742205
1 changed files with 14 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
readme.md
View File

@ -1,12 +1,21 @@
# KBD firmware # KBD firmware
## How to build ## How to build
Get src of `qmk/qmk_firmware` and `vial-kb/vial-qmk` first
## 1. Setting Up Your QMK Environment
Please see https://docs.qmk.fm/#/newbs_getting_started and set up 1 to 3.
## 2. Getting source files
Please get source files of `qmk/qmk_firmware` and `vial-kb/vial-qmk`
```sh ```sh
make git-submodule make git-submodule
``` ```
### VIA ## 3. Building firmwares
### for VIA
```sh ```sh
make qmk-clean make qmk-clean
@ -16,7 +25,7 @@ kb=crkbd kr=rev4/standard km=via make qmk-compile
A built data will be stored on `keyboards/crkbd/qmk/qmk_firmware/.build`\ A built data will be stored on `keyboards/crkbd/qmk/qmk_firmware/.build`\
Please change `kb`, `kr` and `km` when build other. Please change `kb`, `kr` and `km` when build other.
### Vial ### for Vial
```sh ```sh
make vial-qmk-clean make vial-qmk-clean
kb=crkbd make vial-qmk-init kb=crkbd make vial-qmk-init
@ -25,7 +34,7 @@ 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`\ A built data will be stored on `keyboards/crkbd/vial-kb/vial-qmk/.build`\
Please change `kb`, `kr` and `km` when build other. Please change `kb`, `kr` and `km` when build other.
### All clean and build ### All cleaning and building
```sh ```sh
make git-submodule make update-al
``` ```