mirror of
https://github.com/openstenoproject/qmk
synced 2024-11-14 04:24:41 +00:00
Update readme for steno-specific changes
This commit is contained in:
parent
627e35b7ac
commit
2a68b3ce9f
1 changed files with 15 additions and 31 deletions
46
readme.md
46
readme.md
|
@ -1,36 +1,20 @@
|
|||
# Quantum Mechanical Keyboard Firmware
|
||||
# QMK Steno Firmware
|
||||
|
||||
[![Current Version](https://img.shields.io/github/tag/qmk/qmk_firmware.svg)](https://github.com/qmk/qmk_firmware/tags)
|
||||
[![Discord](https://img.shields.io/discord/440868230475677696.svg)](https://discord.gg/Uq7gcHh)
|
||||
[![Docs Status](https://img.shields.io/badge/docs-ready-orange.svg)](https://docs.qmk.fm)
|
||||
[![GitHub contributors](https://img.shields.io/github/contributors/qmk/qmk_firmware.svg)](https://github.com/qmk/qmk_firmware/pulse/monthly)
|
||||
[![GitHub forks](https://img.shields.io/github/forks/qmk/qmk_firmware.svg?style=social&label=Fork)](https://github.com/qmk/qmk_firmware/)
|
||||
This repository is a fork of the [QMK firmware](https://github.com/qmk/qmk_firmware)
|
||||
containing changes specific to hobbyist steno keyboards that are not currently
|
||||
merged into upstream QMK:
|
||||
|
||||
This is a keyboard firmware based on the [tmk\_keyboard firmware](https://github.com/tmk/tmk_keyboard) with some useful features for Atmel AVR and ARM controllers, and more specifically, the [OLKB product line](https://olkb.com), the [ErgoDox EZ](https://ergodox-ez.com) keyboard, and the [Clueboard product line](https://clueboard.co).
|
||||
- Support for protocols like [Plover HID](https://github.com/dnaq/plover-machine-hid)
|
||||
- New keyboards, such as Ecosteno
|
||||
- Optional behavior changes such as first-up chord send and chord repeat
|
||||
|
||||
## Documentation
|
||||
See the [QMK firmware](https://github.com/qmk/qmk_firmware) repository and
|
||||
documentation for more information on QMK itself.
|
||||
|
||||
* [See the official documentation on docs.qmk.fm](https://docs.qmk.fm)
|
||||
## Keyboards Supported
|
||||
|
||||
The docs are powered by [Docsify](https://docsify.js.org/) and hosted on [GitHub](/docs/). They are also viewable offline; see [Previewing the Documentation](https://docs.qmk.fm/#/contributing?id=previewing-the-documentation) for more details.
|
||||
|
||||
You can request changes by making a fork and opening a [pull request](https://github.com/qmk/qmk_firmware/pulls), or by clicking the "Edit this page" link at the bottom of any page.
|
||||
|
||||
## Supported Keyboards
|
||||
|
||||
* [Planck](/keyboards/planck/)
|
||||
* [Preonic](/keyboards/preonic/)
|
||||
* [ErgoDox EZ](/keyboards/ergodox_ez/)
|
||||
* [Clueboard](/keyboards/clueboard/)
|
||||
* [Cluepad](/keyboards/clueboard/17/)
|
||||
* [Atreus](/keyboards/atreus/)
|
||||
|
||||
The project also includes community support for [lots of other keyboards](/keyboards/).
|
||||
|
||||
## Maintainers
|
||||
|
||||
QMK is developed and maintained by Jack Humbert of OLKB with contributions from the community, and of course, [Hasu](https://github.com/tmk). The OLKB product firmwares are maintained by [Jack Humbert](https://github.com/jackhumbert), the Ergodox EZ by [ZSA Technology Labs](https://github.com/zsa), the Clueboard by [Zach White](https://github.com/skullydazed), and the Atreus by [Phil Hagelberg](https://github.com/technomancy).
|
||||
|
||||
## Official Website
|
||||
|
||||
[qmk.fm](https://qmk.fm) is the official website of QMK, where you can find links to this page, the documentation, and the keyboards supported by QMK.
|
||||
- Georgi (`gboards/georgi`): [source](https://github.com/openstenoproject/qmk/tree/main/keyboards/gboards/georgi)
|
||||
- Splitography (`splitography`): [source](https://github.com/openstenoproject/qmk/tree/main/keyboards/splitography)
|
||||
- The Uni (`the_uni/pro_micro` for v2, `the_uni/usb_c` for v3): [source](https://github.com/openstenoproject/qmk/tree/main/keyboards/the_uni), [binary](https://github.com/petercpark/stenokeyboards-firmware)
|
||||
- Ecosteno: [binary](https://github.com/nkotech/EcoSteno-Firmware/tree/main/keyboards/noll)
|
||||
- Multisteno: [binary](https://github.com/nkotech/EcoSteno-Firmware/tree/main/keyboards/noll)
|
||||
|
|
Loading…
Reference in a new issue