QMK/README.md

19 lines
683 B
Markdown
Raw Normal View History

2022-07-09 14:25:45 -07:00
# Betalupi QMK environment
2022-12-27 13:37:44 -08:00
This repository contains my keyboards' firmware and everything you need to build it. It includes a docker container for building QMK firmware, since QMK installation modifies my computer a bit more than I'd like.
2022-07-09 14:25:45 -07:00
2022-12-27 13:37:44 -08:00
## Usage
2022-07-09 14:25:45 -07:00
2022-12-27 13:37:44 -08:00
You do not need a local install of QMK to build this firmware.
You'll need docker, but there's a good chance you have that installed anyway.
2022-07-09 14:25:45 -07:00
2022-12-27 13:37:44 -08:00
1. `cd` into [`./docker`](./docker) and build the container.
2. `mkdir ./output`
3. Run `./build.sh`.
4. Upload the firmware in `./output` to your keyboard using the proper tool.
- `wally-cli` works pretty well for the `betalupi_ergodox`
2022-07-09 14:25:45 -07:00
2022-12-27 13:37:44 -08:00
## Todo
- FFT Animation: clear leds on sleep
2022-07-09 14:25:45 -07:00