QMK/README.md

33 lines
952 B
Markdown
Raw Normal View History

2022-07-09 14:25:45 -07:00
# Betalupi QMK environment
This repository contains everything required to build qmk firmware.
### TODO
2022-07-09 14:28:36 -07:00
- Better build/flash command
- Warning when directory is moved
2022-07-09 14:25:45 -07:00
-------------------------------------------------
## Setup
To initialize the build environment, run `make setup`. This does a few things:
- 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.
2022-07-09 14:49:39 -07:00
Once `make setup` has been run, this directory (or its parents) CANNOT BE RENAMED OR MOVED!
2022-07-09 14:25:45 -07:00
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`.