diff options
Diffstat (limited to 'keyboards/ferris/readme.md')
| -rw-r--r-- | keyboards/ferris/readme.md | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/keyboards/ferris/readme.md b/keyboards/ferris/readme.md new file mode 100644 index 000000000..74a08a38f --- /dev/null +++ b/keyboards/ferris/readme.md | |||
| @@ -0,0 +1,19 @@ | |||
| 1 | # Ferris | ||
| 2 | |||
| 3 |  | ||
| 4 |  | ||
| 5 | |||
| 6 | 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) | ||
| 7 | |||
| 8 | * Keyboard Maintainer: [Pierre Chevalier](https://github.com/pierrechevalier83) | ||
| 9 | * Hardware Supported: | ||
| 10 | * Ferris 0.1 (With atmega32u4 chip. Comes in 4 variants: base, low, high and compact) | ||
| 11 | * Ferris sweep (With pro-micro. Comes in a couple of PCB edge cuts shapes, but with identical pinout) | ||
| 12 | * Hardware Availability: Pierre Chevalier has been selling keyboard kits (see the #ferris channel in the 40% discord chat). Wider availability is on the horizon. | ||
| 13 | |||
| 14 | Make examples for this keyboard (after setting up your build environment): | ||
| 15 | |||
| 16 | make ferris/0_1:default | ||
| 17 | make ferris/sweep:default:avrdude-split-right | ||
| 18 | |||
| 19 | 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). | ||
