summaryrefslogtreecommitdiff
path: root/keyboards/ferris/0_1/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/ferris/0_1/readme.md')
-rw-r--r--keyboards/ferris/0_1/readme.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/keyboards/ferris/0_1/readme.md b/keyboards/ferris/0_1/readme.md
new file mode 100644
index 0000000000..336ee3863e
--- /dev/null
+++ b/keyboards/ferris/0_1/readme.md
@@ -0,0 +1,17 @@
+# Ferris 0.1
+
+![Ferris 0.1 - base, top view](https://i.imgur.com/s6nTn0Ch.jpg)
+![Ferris 0.1 - base, bottom view](https://i.imgur.com/Ymlac2Ah.jpg)
+
+An atmega32u4 based 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 0.1: atmega32u4 chip. Comes in 4 variants: base, low, high and compact
+* Hardware Availability: Pierre Chevalier has been selling keyboard kits (see the #ferris channel in the 40% discord chat). Wider availability is on the horizon.
+
+Make examples for this keyboard (after setting up your build environment):
+
+ make ferris/0_1: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).