summaryrefslogtreecommitdiffstats
path: root/keyboards/fleuron/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/fleuron/readme.md')
-rw-r--r--keyboards/fleuron/readme.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/keyboards/fleuron/readme.md b/keyboards/fleuron/readme.md
new file mode 100644
index 000000000..077753a28
--- /dev/null
+++ b/keyboards/fleuron/readme.md
@@ -0,0 +1,16 @@
+# Fleuron
+
+![Fleuron](https://i.imgur.com/ejXBFRP.jpg "the fleuron keyboard")
+
+The Fleuron keyboard is a 6x16 ortho keyboard supporting right, left, or center numpad placement and rgb backlighting.
+
+Keyboard Maintainer: [James Underwood](https://github.com/ju0)
+Hardware Supported: The Fleuron pcb, ATmega32u4 based controller
+Hardware Availability: limited production run, contact maintainer for details
+
+Make example for this keyboard (after setting up your build environment):
+
+ make fleuron:default to build firmware
+ make fleuron:default:dfu to make and flash with dfu
+
+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. \ No newline at end of file