Mark/QMK
1
1
Fork 0
Code Issues Pull Requests Packages Projects Releases Activity

Reworked build system

Browse Source
This commit is contained in:
Mark
2022-11-18 23:33:15 -08:00
parent 6e84592338
commit 7082172bc4
8 changed files with 16 additions and 118 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -13,22 +13,8 @@ This repository contains everything required to build qmk firmware.
-------------------------------------------------
## Setup
To initialize the build environment, run `make setup`. This does a few things:
## Building
- Updates all submodules
- Symlinks all directories in `keyboards` into `qmk/qmk_fm/keyboards`
- Creates a python virtualenv in `venv`
- Builds and installs `qmk/qmk_cli` into that venv
- Creates a QMK config file in `qmk/qmk.conf`
- Runs `qmk doctor` to make sure everything worked.
Once `make setup` has been run, this directory (or its parents) CANNOT BE RENAMED OR MOVED!
If you want to move this directory, run `make unsetup`, then run `make setup` again. No data should be lost.
## Using QMK
Run `make flash` to build and flash firmware. If you want to execute qmk manually, activate the virtualenv and use `./qmk.sh`.
Run `./build.sh`. Uses docker, doesn't need a local install of qmk.