qmk_firmware

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

readme.md (1299B)

      1 # SNAP
      2 
      3 ![SNAP](https://nullbits.co/static/img/snap10.jpg)
      4 
      5 A unique, tweakable split 75% keyboard kit built by nullbits. [More info at nullbits.co](https://nullbits.co/snap/)
      6 
      7 * Keyboard Maintainer: [Jay Greco](https://github.com/jaygreco)
      8 * Hardware Supported: SNAP Rev1, Pro Micro comaptible MCUs.
      9 * Hardware Availability: [nullbits.co](https://nullbits.co/)
     10 
     11 Note: If you are seeing issues with MacOS and keyboard hangs after sleep, make sure `NO_USB_STARTUP_CHECK = yes` is set in your rules.mk.
     12 
     13 Adds experimental "Remote Keyboard" functionality, which forwards keystrokes from an external macropad, keyboard, or numpad over UART/TRRS, removing the need for an additional USB connection. 
     14 
     15 Make example for this keyboard (after setting up your build environment):
     16 
     17     make nullbitsco/snap:default
     18 
     19 ## Bootloader
     20 
     21 Enter the bootloader in 2 ways:
     22 
     23 * **Physical reset button**: Briefly press the reset button located near the MCU on the the PCB
     24 * **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available
     25 
     26 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).