qmk_firmware

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

readme.md (1694B)


      1 # Model-B
      2 
      3 A 75% keyboard based on the RP2040.
      4 
      5 * Keyboard Maintainer: [Brian Hill](https://github.com/TrojanPinata)
      6 * Hardware Supported: [GitHub](https://github.com/TrojanPinata/Model-B)
      7 
      8 ## Revisions
      9 
     10 At the current moment there is only one variant of the Model-B, the rev-0 (aka the prototype board). Any others are clones and may not have the exact firmware requirements.
     11 
     12 ## Building and Flashing
     13 
     14 Make example for this keyboard (after setting up your build environment):
     15 
     16     make trojan_pinata/model-b/rev0:default
     17     
     18 Flashing example for this keyboard:
     19 
     20     make trojan_pinata/model-b/rev0:default:flash
     21 
     22 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).
     23 
     24 ## Bootloader
     25 
     26 Enter the bootloader in 3 ways:
     27 
     28 * **Bootmagic reset**: Hold down the top left key and plug in the keyboard. This will also clear the emulated EEPROM, so it is a good first step if the keyboard is misbehaving.
     29 * **Physical reset button**: Hold down the `BOOTSEL` button on the Pi Pico, then either plug the board in or press the `RESET` button.
     30 * **Keycode in layout**: Press the key mapped to `QK_BOOT`. In the pre-supplied keymaps it is on the second layer, replacing the Esc key.
     31 
     32 After entering the bootloader through one of the three methods above, the keyboard will appear as a USB mass storage device named `RPI-RP2`. If the CLI is unable to find this device, the compiled `.uf2` file can be manually copied to it. The keyboard will reboot on completion with the new firmware loaded.