From 9fb112feb16f89f23f9ca25a3b2880d5fc6d07a8 Mon Sep 17 00:00:00 2001 From: Mark Date: Tue, 27 Dec 2022 13:37:44 -0800 Subject: [PATCH] Updated README --- README.md | 26 +++++++++++--------------- docker/README.md | 3 ++- 2 files changed, 13 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 3d0dd4a..b0dd1c7 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,18 @@ # Betalupi QMK environment -This repository contains everything required to build qmk firmware. +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. +## Usage -### TODO - - **Core:** - - Better build/flash command - - Warning when directory is moved - - **Keyboard:** - - Random FFT animation - - Clear leds on sleep (fft anim) +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. -------------------------------------------------- +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` - -## Building - -`mkdir ./output` manually. - -Run `./build.sh`. Uses docker, doesn't need a local install of qmk. +## Todo + - FFT Animation: clear leds on sleep diff --git a/docker/README.md b/docker/README.md index ac807c7..0c80417 100644 --- a/docker/README.md +++ b/docker/README.md @@ -20,5 +20,6 @@ docker run -it \ ## Building 1. Before building, run `git submodule update --init --recursive`. -2. Checkout whatever version of `qmk_firmware` you need + - Note that the submodules in this repo are linked to my local mirrors for speed. You'll probably need to update `qmk_cli` and `qmk_firmware` with github links. +2. Checkout whatever version of `qmk_firmware` you need (optional). 3. Run `docker build . -t git.betalupi.com/mark/qmk` \ No newline at end of file