summaryrefslogtreecommitdiff
path: root/keyboards/densus/alveus/mx/readme.md
diff options
context:
space:
mode:
authormechlovin <57231893+mechlovin@users.noreply.github.com>2023-06-19 12:23:11 +0700
committerGitHub <noreply@github.com>2023-06-18 23:23:11 -0600
commite646ec20243f6e628d4b295fae830bdfdd219bad (patch)
tree4853d2d2606b04ed8ccbf88725a5003cf059f2e9 /keyboards/densus/alveus/mx/readme.md
parent0774381f81ba69c2c37fd002a846d03f9e9e7cfd (diff)
[Keyboard] Add support for Alveus MX PCB (#21238)
Co-authored-by: jack <0x6a73@protonmail.com>
Diffstat (limited to 'keyboards/densus/alveus/mx/readme.md')
-rw-r--r--keyboards/densus/alveus/mx/readme.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/keyboards/densus/alveus/mx/readme.md b/keyboards/densus/alveus/mx/readme.md
new file mode 100644
index 0000000000..3a90c9b0f3
--- /dev/null
+++ b/keyboards/densus/alveus/mx/readme.md
@@ -0,0 +1,26 @@
+# Alveus
+
+![Alveus PCB](https://i.imgur.com/tZKcLiMh.png)
+
+A MX PCB for Alveus FRL keyboard.
+
+* Keyboard Maintainer: [Mechlovin' Studio](https://mechlovin.studio/)
+* Hardware Supported: Alveus, APM32F103
+* Hardware Availability: [Densus](https://www.instagram.com/densusdesign/)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make densus/alveus/mx:default
+
+Flashing example for this keyboard:
+
+ make densus/alveus/mx:default:flash
+
+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).
+
+Enter the bootloader in 4 ways:
+
+* **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard
+* **Bootloader reset**: Hold down the key at (0,13) in the matrix (Backspace) and plug in the keyboard
+* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available
+* **Hardware reset**: Press reset button (located on the bottom side of the PCB) \ No newline at end of file