From b000b06305b7a434f051395ec43179636cc6150c Mon Sep 17 00:00:00 2001 From: Benji Date: Fri, 20 Nov 2026 00:11:53 +0000 Subject: [PATCH] build on push, add flashing instructions :) --- .gitea/workflows/build.yml | 3 ++- INSTALL.md | 29 +++++++++++++++++++++++++++++ 2 files changed, 31 insertions(+), 1 deletion(-) create mode 100644 INSTALL.md diff --git a/.gitea/workflows/build.yml b/.gitea/workflows/build.yml index e62002f824..1e595205e8 100644 --- a/.gitea/workflows/build.yml +++ b/.gitea/workflows/build.yml @@ -51,7 +51,8 @@ jobs: ID=$(curl -sSf -X POST -H "$AUTH" -H "Content-Type: application/json" "$API/releases" \ -d "$(jq -n --arg sha "${{ gitea.sha }}" \ - '{tag_name:"latest", target_commitish:$sha, name:"Latest firmware", body:("Built from " + $sha)}')" \ + --arg url "${{ gitea.server_url }}/${{ gitea.repository }}/src/branch/main/INSTALL.md" \ + '{tag_name:"latest", target_commitish:$sha, name:"Latest firmware", body:("Built from " + $sha + "\n\nHow to flash it: " + $url)}')" \ | jq -r .id) curl -sSf -H "$AUTH" -F "attachment=@$RUNNER_TEMP/firmware.bin" \ diff --git a/INSTALL.md b/INSTALL.md new file mode 100644 index 0000000000..0cb3d46526 --- /dev/null +++ b/INSTALL.md @@ -0,0 +1,29 @@ +# how to install (qmk not needed!) + +1. Download `preonic_rev3_mindfulminun.bin` from the + [latest release](https://gitea.benjic.xyz/mindfulminun/qmk/releases/tag/latest). +2. Put the keyboard in bootloader mode. +3. Flash it with one of the options below. + +## Option A (ez): QMK Toolbox (graphical) + +Get it from the [QMK Toolbox releases](https://github.com/qmk/qmk_toolbox/releases) +(Windows and macOS; check the latest release for Linux support). Open the `.bin` +file, tick "Auto-Flash" or click Flash, and the Toolbox installs any drivers it needs. + +## Option B (leet): dfu-util (cli, all systems) + +Install it: + +- **macOS:** `brew install dfu-util` +- **Linux:** install the `dfu-util` package from your distro + (e.g. `sudo apt install dfu-util` or `sudo pacman -S dfu-util`) +- **Windows:** download it from + and unzip it. If the keyboard isn't detected, install the WinUSB driver for the + "STM32 BOOTLOADER" device with [Zadig](https://zadig.akeo.ie/). + +``` +dfu-util -a 0 -d 0483:df11 -s 0x08000000:leave -D preonic_rev3_mindfulminun.bin +``` + +The keyboard restarts on its own when the flash finishes.