logo

qmk_firmware

custom branch of QMK firmware git clone https://anongit.hacktivis.me/git/qmk_firmware.git

readme.md (1888B)

    

  1. # The Redox keyboard
  3. <p align="center">
  4. <img src="https://github.com/mattdibi/redox-keyboard/raw/master/img/redox-logo.png" alt="Redox logo" width="600"/>
  5. </p>
  7. <p align="center">
  8. <img src="https://github.com/mattdibi/redox-keyboard/raw/master/img/redox-pcb2.jpg" alt="Redox PCB rev1.0" width="600"/>
  9. </p>
  11. **Redox**: the **R**educed **E**rgo**dox** project. More information and building instruction [here](https://github.com/mattdibi/redox-keyboard).
  13. - Keyboard Maintainer: [Mattia Dal Ben](https://github.com/mattdibi)  
  14. - Hardware Supported: 
  15.     - Redox PCB rev1.0 
  16.     - Pro Micro or Proton C micro controllers
  17. - Hardware Availability: [Falbatech](https://falba.tech/product-category/keyboard-parts/redox-parts/)
  19. Make example for this keyboard (after setting up [qmk](https://docs.qmk.fm/#/getting_started_build_tools)):
  21. To build the Pro Micro firmware, first set your config:
  22. ```sh
  23. qmk config user.keyboard=redox/rev1
  24. ```
  25. or if your using the Proton C:
  26. ```sh
  27. qmk config user.keyboard=redox/rev1/proton_c
  28. ```
  30. Don't forget to set a layout. There's many to choose from in the keymaps folder.
  31. ```sh
  32. qmk config user.keymap=default
  33. ```
  35. Now you can build your firmware!
  36. ```sh
  37. qmk compile
  38. ```
  40. Flashing is also straightforward. Run:
  41. ```sh
  42. qmk flash
  43. ```
  44. Enter the bootloader when prompted by doing one of the following:
  45. * **Physical reset button**: Briefly press the button on the back of the PCB
  46. * **Keycode in layout**: Press the key mapped to `QK_BOOT` if you have a layout that has one.
  48. The WS2812 driver is *untested* on the Proton C, but if you choose to use this feature, you will need to source 5v from the Proton's VUSB pin and not use the PCB's dedicated pin which will be 3v3 *and* follow the [documentation](https://docs.qmk.fm/#/ws2812_driver) to enable the correct driver settings.
  50. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).