aboutsummaryrefslogtreecommitdiffstats
path: root/keyboards/handwired/ferris/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/handwired/ferris/readme.md')
-rw-r--r--keyboards/handwired/ferris/readme.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/keyboards/handwired/ferris/readme.md b/keyboards/handwired/ferris/readme.md
new file mode 100644
index 000000000..23aeca874
--- /dev/null
+++ b/keyboards/handwired/ferris/readme.md
@@ -0,0 +1,16 @@
+# Ferris
+
+![Ferris, top view](https://imgur.com/V4QuaGs.jpg)
+![Ferris, bottom view](https://i.imgur.com/7DJYME8.jpg)
+
+A split 34 keys column staggered keyboard named and decorated after the rustlang mascott. All PCB files and some thoughts on the design are available on the [project's github page](https://github.com/pierrechevalier83/ferris)
+
+* Keyboard Maintainer: [Pierre Chevalier](https://github.com/pierrechevalier83)
+* Hardware Supported: Ferris PCB
+* Hardware Availability: Still in prototype stage
+
+Make example for this keyboard (after setting up your build environment):
+
+ make handwired/ferris:default
+
+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).