qmk_firmware

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

readme.md (1976B)

      1 # GeonWorks Frog Mini PCB firmware
      2 
      3 ![FM_image](https://i.imgur.com/mhCsc6Mh.jpg)
      4 
      5 The Frog Mini is a 60% keyboard designed by GeonWorks, with PCB by Gondolindrim.
      6 
      7 Two PCB variants are offered: FM-S (solderable) and FM-H (hotswap with Kailh sockets).
      8 
      9 * Keyboard Maintainer: [Gondolindrim](https://github.com/gondolindrim)
     10 * Hardware Availability: proprietary PCB sold by [Geon.Works](https://geon.works/)
     11 * Website: [GeonWorks](https://geon.works/pages/frog-mini)
     12 
     13 ## How to flash
     14 
     15 ### Enter bootloader
     16 
     17 ### Release Alpha:
     18 
     19 The DFU state in the bootloader can be accessed in 2 ways:
     20 
     21 * **Bootmagic reset**: hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard
     22 * **Physical reset button**: press the button on the back of the PCB
     23 * **Keycode in layout**: press the key mapped to `QK_BOOT` if it is available (ESC key at layer 1 in the default layout)
     24 
     25 ### Release Beta:
     26 
     27 The DFU state in the bootloader can be accessed in 3 ways:
     28 
     29 * **Bootmagic reset**: hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard
     30 * **Physical reset button**: press the button on the back of the PCB, for at least five seconds
     31 * **Keycode in layout**: press the key mapped to `QK_BOOT` if it is available (ESC key at layer 1 in the default layout)
     32 
     33 ## Compile firmware
     34 
     35 ### FM-S (solderable)
     36 
     37 After accessing the DFU state in your PCB, build the default layout using:
     38 
     39     make geonworks/frogmini/fms:default
     40 
     41 ### FM-H (hotswap)
     42 
     43 After accessing the DFU state in your PCB, build the default layout using:
     44 
     45     make geonworks/frogmini/fmh:default
     46 
     47 Then download the resulting binary `*bin` file using `dfu-util` or QMK Toolbox.
     48 
     49 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).