summaryrefslogtreecommitdiffstats
path: root/keyboards/anavi/knob1/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/anavi/knob1/readme.md')
-rw-r--r--keyboards/anavi/knob1/readme.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/keyboards/anavi/knob1/readme.md b/keyboards/anavi/knob1/readme.md
new file mode 100644
index 0000000000..08f8f92197
--- /dev/null
+++ b/keyboards/anavi/knob1/readme.md
@@ -0,0 +1,21 @@
+# ANAVI Knob 1
+
+Mini mechanical keyboard with a clickable rotary encoder, USB-C, RP2040 microcontroller and I2C slot.
+
+* Keyboard Maintainer: [Leon Anavi](https://github.com/leon-anavi)
+* Hardware Supported: ANAVI Knob 1
+* Hardware Availability: [Crowd Supply](https://www.crowdsupply.com/anavi-technology/anavi-macro-pad-10), [GitHub repository](https://github.com/AnaviTechnology/anavi-knob-1)
+
+Make example for this keyboard (after setting up your build environment):
+
+ qmk compile -kb anavi/knob1 -km default
+
+See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
+
+## Bootloader
+
+Enter the bootloader in 3 ways:
+
+* **Bootmagic reset**: Hold down the top left key on the left half, or top right key on the right half, and then plug in the USB cable on that keyboard half.
+* **Physical reset button**: Double tap the reset button on the XIAO RP2040.
+* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available.