diff --git a/readme.md b/readme.md index 590de082..ecd91e86 100644 --- a/readme.md +++ b/readme.md @@ -1,12 +1,21 @@ # KBD firmware ## 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 make git-submodule ``` -### VIA +## 3. Building firmwares + +### for VIA ```sh 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`\ Please change `kb`, `kr` and `km` when build other. -### Vial +### for Vial ```sh make vial-qmk-clean 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`\ Please change `kb`, `kr` and `km` when build other. -### All clean and build +### All cleaning and building ```sh -make git-submodule +make update-al ```