Build tool for my out-of-tree QMK stuff.
It mainly is a fancy wrapper on top of git and qmk CLIs, this way I can "easily" have my code up to date with latest changes on QMK's codebase. Right now the tool can:
- checkout file(s) from other branches(even on other repos)
- copy files into the repo's filesystem (sort of adding fixtures)
- apply patches/diffs
- execute commands
- merge branches
- pick up the changes on a PR
As a nice extra, i made the tool auto-detect changes to its own source code and self-update. If you change any file on this folder and run the tool, you'll get:
$ qmk_build
[WARN] Detected changes on my source code, attempting to re-compile myself...
[WARN] Done. Can compile firmware now ^^
$ qmk_build
// now it actually runs //
- Install Rust (official docs)
- Compile and install the executable (from this folder)
$ cargo install --path .
- Describe your compilation setup on a HJSON file. You can probably setup your editor to suggest based on
./schema. You can see how that's done on VSCode within.vscode/ - Run the tool against your settings file.
$ qmk_build <filename>
Note: If you don't provide an argument, it defaults to build.json.
Thanks to the self-update, tool should be easy to contribute to:
- No need for manual re-compiling after changes (can't forget to)
- Code is formatted/linted during self-update and schema is re-generated
Granted your changes compile and work as intended, feel free to PR. ie: There are no formatting rules or whatever from my end.
This repo used to contain my code along with the tool, it's possible you followed an old link. For now (Novemeber '23) code lives on github/elpekenin/access