diff --git a/README.md b/README.md new file mode 100644 index 0000000000..76063b4201 --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ +# MindfulMinun's Preonic layout - largely based on the Planck's + +## Setup + +### 1. Install QMK and clone the firmware + +```bash +sudo pacman -S qmk +git clone --depth 1 https://github.com/qmk/qmk_firmware ~/qmk_firmware +qmk config user.qmk_home=~/qmk_firmware +``` + +### 2. Clone this repo into the userspace overlay + +```bash +git clone https://gitea.benjic.xyz/mindfulminun/qmk.git +qmk config user.overlay_dir=~/qmk-userspace +``` + +### 3. Flash + +```bash +cd ~/qmk_firmware +make preonic/rev3:MindfulMinun:flash +``` + +When prompted, press the reset button on the bottom of the keyboard.