Files
qmk/README.md
T
mindfulminun 727e15ac34
Build firmware / build (push) Successful in 1m46s
update README install instructions
2026-11-20 00:33:50 +00:00

36 lines
834 B
Markdown

# 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
```
### 1. Install QMK CLI
```bash
sudo pacman -S python-pipx
pipx install qmk
qmk setup --home ~/.local/share/qmk_firmware
```
### 2. Set your userspace directory
```bash
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.