aboutsummaryrefslogtreecommitdiff
path: root/keyboards/redox/readme.md
diff options
context:
space:
mode:
authorxerootg <xerootg@users.noreply.github.com>2022-01-31 12:40:13 -0700
committerGitHub <noreply@github.com>2022-01-31 11:40:13 -0800
commit1111ff604d1b006ffd29a0c52d7f717b7879cd00 (patch)
tree07ff78851c3c4f9c8ee45c6e8c59e4d509ccffc6 /keyboards/redox/readme.md
parent59ebe28cd5e50ffda700f127060f936c2d60ed0a (diff)
downloadqmk_firmware-1111ff604d1b006ffd29a0c52d7f717b7879cd00.tar.gz
qmk_firmware-1111ff604d1b006ffd29a0c52d7f717b7879cd00.zip
[Keyboard] Add the proton c as a controller for the redox (#16106)
Co-authored-by: Sergey Vlasov <sigprof@gmail.com> Co-authored-by: xerootg <xerootg@github.com>
Diffstat (limited to 'keyboards/redox/readme.md')
-rw-r--r--keyboards/redox/readme.md31
1 files changed, 25 insertions, 6 deletions
diff --git a/keyboards/redox/readme.md b/keyboards/redox/readme.md
index d237caf01..27333b518 100644
--- a/keyboards/redox/readme.md
+++ b/keyboards/redox/readme.md
@@ -11,19 +11,38 @@
11**Redox**: the **R**educed **E**rgo**dox** project. More information and building instruction [here](https://github.com/mattdibi/redox-keyboard). 11**Redox**: the **R**educed **E**rgo**dox** project. More information and building instruction [here](https://github.com/mattdibi/redox-keyboard).
12 12
13- Keyboard Maintainer: [Mattia Dal Ben](https://github.com/mattdibi) 13- Keyboard Maintainer: [Mattia Dal Ben](https://github.com/mattdibi)
14- Hardware Supported: Redox PCB rev1.0 w/ Pro Micro 14- Hardware Supported: Redox PCB rev1.0 w/ Pro Micro or Proton C
15- Hardware Availability: [Falbatech](https://falba.tech/product-category/keyboard-parts/redox-parts/) 15- Hardware Availability: [Falbatech](https://falba.tech/product-category/keyboard-parts/redox-parts/)
16 16
17Make example for this keyboard (after setting up your build environment): 17Make example for this keyboard (after setting up [qmk](https://docs.qmk.fm/#/getting_started_build_tools)):
18 18
19To build the Pro Micro firmware, first set your config:
19```sh 20```sh
20make redox/rev1:default 21qmk config user.keyboard=redox/rev1
22```
23or if your using the Proton C:
24```sh
25qmk config user.keyboard=redox/rev1/proton_c
26```
27
28Don't forget to set a layout. There's many to choose from in the keymaps folder.
29```sh
30qmk config user.keymap=default
21``` 31```
22 32
23Example of flashing this keyboard: 33Now you can build your firmware!
34```sh
35qmk compile
36```
24 37
38Flashing is also straightforward. Run:
25```sh 39```sh
26make redox/rev1:default:avrdude 40qmk flash
27``` 41```
42Enter the bootloader when prompted by doing one of the following:
43* **Physical reset button**: Briefly press the button on the back of the PCB
44* **Keycode in layout**: Press the key mapped to `RESET` if you have a layout that has one.
45
46The 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.
28 47
29See 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). 48Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).