summaryrefslogtreecommitdiff
path: root/keyboards/smithrune/magnus/readme.md
diff options
context:
space:
mode:
authorÁlvaro A. Volpato <alvaro.augusto.volpato@gmail.com>2023-11-29 04:47:08 -0300
committerGitHub <noreply@github.com>2023-11-28 23:47:08 -0800
commit93127df5d41681e7d7d42d87d1b93ccff4d670c5 (patch)
tree41e35ef42c2096eedb2b042fa768bba225ed636a /keyboards/smithrune/magnus/readme.md
parentc8a28e8e9bf85508a2b34ed0f839f83d8cc77384 (diff)
Add Smith and Rune Magnus (#22153)
Co-authored-by: Less/Rikki <86894501+lesshonor@users.noreply.github.com> Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: Duncan Sutherland <dunk2k_2000@hotmail.com>
Diffstat (limited to 'keyboards/smithrune/magnus/readme.md')
-rw-r--r--keyboards/smithrune/magnus/readme.md35
1 files changed, 35 insertions, 0 deletions
diff --git a/keyboards/smithrune/magnus/readme.md b/keyboards/smithrune/magnus/readme.md
new file mode 100644
index 0000000000..f8fa005bf3
--- /dev/null
+++ b/keyboards/smithrune/magnus/readme.md
@@ -0,0 +1,35 @@
+# Smith and Rune Magnus
+
+![magnus](https://imgur.com/bemM7ZZh.jpg)
+
+## Introduction
+
+This is the QMK Firmware repository for the Magnus, a keyboard designed by [Smith and Rune](https://smithrune.com/) and PCBs designed by [Gondolindrim](http://github.com/Gondolindrim), who is also the firwmare maintainer.
+
+The Magnus keyboard has two PCB versions: a solderable version (m75s) and a hotswap version (m75h). While M75S has support for a myriad of alternative layouts, including a 7U bottom row and ISO, M75H only supports full and split backspace alternatives. Also, while M75S supports in-switch single-color LEDs and RGB LEDs for underglow light, M75H only supports RGB underglow.
+
+As of July 2023, the Magnus groubuy is already finished.
+
+## How to flash
+
+### Enter bootloader
+
+The DFU state in the bootloader can be accessed in 3 ways:
+
+* **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key, escape in the default keymap) and plug in the keyboard;
+* **Physical reset button**: press the button on the front of the PCB, next to caps lock, for at least five seconds;
+* **Keycode in layout**: Press the key mapped to `QK_BOOT`; in the default layout, that is top left key ('escape') in layer 1.
+
+### How to compile and flash
+
+After checking what PCB you own and setting up your build environment, you can compile the Magnus default keymap by using one of the options below.
+
+ make smithrune/magnus/m75s:default
+ make smithrune/magnus/m75h:default
+
+And use `dfu-util` in the command line or through a GUI like QMK toolbox to upload the firmware to the PCB. To directly flash the PCB after it is put into a DFU state, use:
+
+ make smithrune/magnus/m75s:default:flash
+ make smithrune/magnus/m75h: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).