diff options
Diffstat (limited to 'keyboards/buzzard/readme.md')
| -rw-r--r-- | keyboards/buzzard/readme.md | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/keyboards/buzzard/readme.md b/keyboards/buzzard/readme.md new file mode 100644 index 000000000..d86c2feb3 --- /dev/null +++ b/keyboards/buzzard/readme.md | |||
| @@ -0,0 +1,29 @@ | |||
| 1 | # Buzzard | ||
| 2 | |||
| 3 |  | ||
| 4 | |||
| 5 | Buzzard is a 40 keys ergonomic split keyboard. The layout is inspired by the [Architeuthis dux](https://github.com/tapioki/cephalopoda/tree/main/Architeuthis%20dux) with pinky, ring, index, and inner columns splayed at 15, 5, 0, -5, -5 degrees. However, it as two additional pinky keys and a modified thumb cluster. | ||
| 6 | |||
| 7 | * Keyboard Maintainer: [crehmann](https://github.com/crehmann) | ||
| 8 | * Hardware Supported: Pro Micro 5V/16MHz and compatible. | ||
| 9 | * Hardware Availability: https://github.com/crehmann/Buzzard | ||
| 10 | |||
| 11 | ## Some Features: | ||
| 12 | |||
| 13 | - Integrated TrackPoint reset circuit and two possible positions to mount a TrackPoint to the bottom of the PCB. Either between the two inner columns or between the index and middle finger columns | ||
| 14 | - Mounting option for a linear actuator ([HapticBuzz from pimoroni](https://shop.pimoroni.com/products/drv2605l-linear-actuator-haptic-breakout)) | ||
| 15 | - I2C interface for an OLED display | ||
| 16 | - Wireless Ready (however, without TrackPoint / linear actuator support): | ||
| 17 | - Battery switch / connector | ||
| 18 | - Option to use a battery friendly Sharp memory display instead of an OLED display | ||
| 19 | - Choc-spaced | ||
| 20 | |||
| 21 | ## Building the Firmware | ||
| 22 | |||
| 23 | Make example for this keyboard (after setting up your build environment): | ||
| 24 | |||
| 25 | qmk compile -kb buzzard -km default | ||
| 26 | |||
| 27 | 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). | ||
| 28 | |||
| 29 | A build guide for the Buzzard keyboard can be found at [https://github.com/crehmann/Buzzard](https://github.com/crehmann/Buzzard) \ No newline at end of file | ||
