summaryrefslogtreecommitdiffstats
path: root/keyboards/redox/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/redox/readme.md')
-rw-r--r--keyboards/redox/readme.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/keyboards/redox/readme.md b/keyboards/redox/readme.md
new file mode 100644
index 000000000..6e1d980a7
--- /dev/null
+++ b/keyboards/redox/readme.md
@@ -0,0 +1,25 @@
+# The Redox keyboard
+
+<p align="center">
+<img src="https://github.com/mattdibi/redox-keyboard/raw/master/img/redox-logo.png" alt="Redox logo" width="600"/>
+</p>
+
+<p align="center">
+<img src="https://github.com/mattdibi/redox-keyboard/raw/master/img/redox-pcb2.jpg" alt="Redox PCB rev1.0" width="600"/>
+</p>
+
+**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 Availability: [Falbatech](https://falba.tech/product-category/keyboard-parts/redox-parts/)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make redox/rev1:default
+
+Example of flashing this keyboard:
+
+ make redox/rev1:default:avrdude
+
+See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) then the [make instructions](https://docs.qmk.fm/make_instructions.html) for more information.