qmk_firmware

QMK firmware for my keyboards (Corne, Sweep Ferris) and trackball (Ploopy Adept)
Log | Files | Refs | Submodules | LICENSE

readme.md (2027B)

      1 # Smith and Rune Magnus
      2 
      3 ![magnus](https://imgur.com/bemM7ZZh.jpg)
      4 
      5 ## Introduction
      6 
      7 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.
      8 
      9 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.
     10 
     11 As of July 2023, the Magnus groubuy is already finished.
     12 
     13 ## How to flash
     14 
     15 ### Enter bootloader
     16 
     17 The DFU state in the bootloader can be accessed in 3 ways:
     18 
     19 * **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;
     20 * **Physical reset button**: press the button on the front of the PCB, next to caps lock, for at least five seconds;
     21 * **Keycode in layout**: Press the key mapped to `QK_BOOT`; in the default layout, that is top left key ('escape') in layer 1.
     22 
     23 ### How to compile and flash
     24 
     25 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.
     26 
     27     make smithrune/magnus/m75s:default
     28     make smithrune/magnus/m75h:default
     29 
     30 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:
     31 
     32     make smithrune/magnus/m75s:default:flash
     33     make smithrune/magnus/m75h:default:flash
     34 
     35 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).