summaryrefslogtreecommitdiffstats
path: root/keyboards/ferris/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/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/readme.md')
-rw-r--r--keyboards/ferris/readme.md6
1 files changed, 5 insertions, 1 deletions
diff --git a/keyboards/ferris/readme.md b/keyboards/ferris/readme.md
index 84ac85b57f..0d1fe284fd 100644
--- a/keyboards/ferris/readme.md
+++ b/keyboards/ferris/readme.md
@@ -9,12 +9,16 @@ A split 34 keys column staggered keyboard named and decorated after the rustlang
* Ferris 0.1 (With atmega32u4 chip. Comes in 4 variants: base, low, high and compact)
* Ferris 0.2 (With stm32f072 chip. Comes in 4 variants: bling, mini, high and compact)
* Ferris sweep (With pro-micro. Comes in a couple of PCB edge cuts shapes, but with identical pinout)
-* Hardware Availability: Pierre Chevalier has been selling keyboard kits (see the #ferris channel in the 40% discord chat). Wider availability is on the horizon.
+* Hardware Availability: [Cuddly Keyboards](https://cuddlykeyboards.com)
Make examples for this keyboard (after setting up your build environment):
make ferris/0_1:default
make ferris/0_2:default
+ make ferris/0_2/bling:default
+ make ferris/0_2/compact:default
+ make ferris/0_2/mini:default
+ make ferris/0_2/high:default
make ferris/sweep:default:avrdude-split-right
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).