summaryrefslogtreecommitdiffstats
path: root/keyboards/fleuron/readme.md
diff options
context:
space:
mode:
authorJames Underwood <ju0@users.noreply.github.com>2018-08-08 02:47:49 +0200
committerDrashna Jaelre <drashna@live.com>2018-08-08 02:47:49 +0200
commit69fef83b0ea6dde3d20e2b239f8a7b54c42ddb12 (patch)
tree0da4d2b16eb120b1a9fe51a7806c34cec8dd30eb /keyboards/fleuron/readme.md
parentfd085837e1ee75c93a568f055fddb5f73bd46ea5 (diff)
downloadqmk_firmware-69fef83b0ea6dde3d20e2b239f8a7b54c42ddb12.tar.gz
qmk_firmware-69fef83b0ea6dde3d20e2b239f8a7b54c42ddb12.tar.xz
Keyboard: Adds Fleuron v1.0 keyboard (#3571)
* Adds Fleuron keyboard directory and default layout * Adds Fleuron keyboard directory and default layout * adds double zero macro, and updates to the new macro methodology * adds raise and lower layers * removes makefile from default layout, turns off mousekey, console, and command in rules.mk * makes upper right key a bksp in default layout, adds .json layout file * updates to default layout * tweak default layout jusabit * fix raise and lower switch case, and scoot a few keycodes around * make changes for PR #3571 * fixing erros for PR #3571 * adds Dollartacos first custom keymap * fixes for PR #3571
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