From 727e15ac3461d738ca599a7e8f7e5ec515973349 Mon Sep 17 00:00:00 2001 From: Benji Date: Fri, 20 Nov 2026 00:33:50 +0000 Subject: [PATCH] update README install instructions --- README.md | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 94659f55c3..9680277aae 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,16 @@ # MindfulMinun's Preonic layout - largely based on the Planck's + + +## Install + +Download the binary from the release, and flash it! + +See [INSTALL.md](https://gitea.benjic.xyz/mindfulminun/qmk/src/branch/main/INSTALL.md) + ## Setup + +You don't need to clone the repo to install. But if you so choose, you can clone this locally: + ### 0. Get this repo! ```bash git clone https://gitea.benjic.xyz/MindfulMinun/qmk --single-branch --branch main @@ -14,12 +25,12 @@ qmk setup --home ~/.local/share/qmk_firmware ### 2. Set your userspace directory ```bash -qmk config user.overlay_dir=~/Documentos/code/git/qmk -# Replace that directory with your cwd (this folder) +qmk config user.overlay_dir=~/path/to/qmk +# Replace that directory with your cwd ``` ### 3. Flash ```bash qmk flash -kb preonic/rev3 -km mindfulminun ``` -When prompted, press the reset button on the bottom of the keyboard. +When prompted, press the reset button on the bottom of the keyboard. \ No newline at end of file