QMK/README.md

16 lines
483 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
2023-12-16 11:21:51 -08: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
2023-12-16 11:21:51 -08:00
1. `make docker`
2. `make`
3. `make upload`
2022-07-09 14:25:45 -07:00
2023-12-16 11:21:51 -08:00
Read [`Makefile`](./Makefile) for details.