diff options
Diffstat (limited to 'keyboards/redox/readme.md')
| -rw-r--r-- | keyboards/redox/readme.md | 31 |
1 files changed, 25 insertions, 6 deletions
diff --git a/keyboards/redox/readme.md b/keyboards/redox/readme.md index d237caf013..27333b518c 100644 --- a/keyboards/redox/readme.md +++ b/keyboards/redox/readme.md @@ -11,19 +11,38 @@ **Redox**: the **R**educed **E**rgo**dox** project. More information and building instruction [here](https://github.com/mattdibi/redox-keyboard). - Keyboard Maintainer: [Mattia Dal Ben](https://github.com/mattdibi) -- Hardware Supported: Redox PCB rev1.0 w/ Pro Micro +- Hardware Supported: Redox PCB rev1.0 w/ Pro Micro or Proton C - Hardware Availability: [Falbatech](https://falba.tech/product-category/keyboard-parts/redox-parts/) -Make example for this keyboard (after setting up your build environment): +Make example for this keyboard (after setting up [qmk](https://docs.qmk.fm/#/getting_started_build_tools)): +To build the Pro Micro firmware, first set your config: ```sh -make redox/rev1:default +qmk config user.keyboard=redox/rev1 +``` +or if your using the Proton C: +```sh +qmk config user.keyboard=redox/rev1/proton_c +``` + +Don't forget to set a layout. There's many to choose from in the keymaps folder. +```sh +qmk config user.keymap=default ``` -Example of flashing this keyboard: +Now you can build your firmware! +```sh +qmk compile +``` +Flashing is also straightforward. Run: ```sh -make redox/rev1:default:avrdude +qmk flash ``` +Enter the bootloader when prompted by doing one of the following: +* **Physical reset button**: Briefly press the button on the back of the PCB +* **Keycode in layout**: Press the key mapped to `RESET` if you have a layout that has one. + +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. -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). +Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). |