summaryrefslogtreecommitdiff
path: root/keyboards/ferris/0_2/compact/readme.md
diff options
context:
space:
mode:
authorPierre Chevalier <pierrechevalier83@gmail.com>2021-08-09 19:23:15 +0100
committerGitHub <noreply@github.com>2021-08-09 11:23:15 -0700
commit23becac3a650ac06e202bac8158b058a8b7b48f2 (patch)
tree63e407bcddd20702afda6df21bad1f8558e3079b /keyboards/ferris/0_2/compact/readme.md
parent5a59363e2826a49ae6dc97d5296f17dc89fd4c7e (diff)
Support all the 0.2 Ferris variants (#12653)
* Support all the 0.2 Ferris variants For the Compact, the High and the Mini, create a new directory so each keyboard may have the correct USB descriptor and a readme with more specific information about it. For the Bling, also add support for the underglow functionality. Change the "MANUFACTURER" string to "Cuddly Keyboards Ltd.", the name of the company I incorporated to sell keyboards, and change the default descriptor from "Ferris the keeb" to "Ferris 0.2" which is more descriptive. I didn't update the 0.1 variants as I don't intend to sell these kits with "Cuddly Keyboards". The firmware is mostly there to support existing users. Update the "hardware availability" to point to my new website: cuddlykeyboards.com. * Add RGB mode toggle to my keymap and to the default keymap * Improve wording in the readme
Diffstat (limited to 'keyboards/ferris/0_2/compact/readme.md')
-rw-r--r--keyboards/ferris/0_2/compact/readme.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/keyboards/ferris/0_2/compact/readme.md b/keyboards/ferris/0_2/compact/readme.md
new file mode 100644
index 0000000000..b17b59bfae
--- /dev/null
+++ b/keyboards/ferris/0_2/compact/readme.md
@@ -0,0 +1,17 @@
+# Ferris 0.2 - Compact
+
+![Ferris 0.2 - Compact, top view](https://i.imgur.com/V2ZLKjih.jpg)
+![Ferris 0.2 - Compact, bottom view](https://i.imgur.com/3icP8pzh.jpg)
+
+Ferris 0.2 - Compact with Kailh Choc support and Choc spacing.
+
+* Keyboard Maintainer: [Pierre Chevalier](https://github.com/pierrechevalier83)
+* Hardware Supported:
+ * Ferris 0.2 - Compact: (STM32F072 MCU on the left, MCP23017 on the right)
+* Hardware Availability: [Cuddly Keyboards](https://cuddlykeyboards.com)
+
+Make examples for this keyboard (after setting up your build environment):
+
+ make ferris/0_2/compact: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).