diff options
| author |  Jack Humbert <jack.humb@gmail.com> | 2018-04-24 12:37:52 -0400 |
|---|---|---|
| committer |  Drashna Jaelre <drashna@live.com> | 2018-04-24 09:37:52 -0700 |
| commit | f440bbbc1124b18ad0cad31976558905d8c15fc0 (patch) | |
| tree | de15b78afd5d4f9f00f6c6e33f9c5c5116ff2c43 /readme.md | |
| parent | eef75b82bdba9fa7e4f19b0f4cf1ffa7afe0c005 (diff) | |
| download | qmk_firmware-f440bbbc1124b18ad0cad31976558905d8c15fc0.tar.gz | |
Update readme.md (#2687)
Diffstat (limited to 'readme.md')
| -rw-r--r-- | readme.md | 12 |
1 files changed, 7 insertions, 5 deletions
@@ -7,11 +7,13 @@ [](https://github.com/qmk/qmk_firmware/pulse/monthly) [](https://github.com/qmk/qmk_firmware/) -This is a keyboard firmware based on the [tmk\_keyboard firmware](http://github.com/tmk/tmk_keyboard) with some useful features for Atmel AVR and ARM controllers, and more specifically, the [OLKB product line](http://olkb.com), the [ErgoDox EZ](http://www.ergodox-ez.com) keyboard, and the [Clueboard product line](http://clueboard.co/). +This is a keyboard firmware based on the [tmk\_keyboard firmware](http://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](http://www.ergodox-ez.com) keyboard, and the [Clueboard product line](http://clueboard.co/). -## Official website +## Documentation -[http://qmk.fm](http://qmk.fm) is the official website of QMK, where you can find links to this page, the documentation, and the keyboards supported by QMK. +* [See the official documentation on docs.qmk.fm](https://docs.qmk.fm) + +The docs are hosted on [Gitbook](https://www.gitbook.com/book/qmk/firmware/details) and [GitHub](/docs/) (they are synced). You can request changes by making a fork and [pull request](https://github.com/qmk/qmk_firmware/pulls), or by clicking the "suggest an edit" link on any page of the docs. ## Supported Keyboards @@ -27,6 +29,6 @@ The project also includes community support for [lots of other keyboards](/keybo 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 [Erez Zukerman](https://github.com/ezuk), and the Clueboard by [Zach White](https://github.com/skullydazed). -## Documentation +## Official website -[https://docs.qmk.fm](https://docs.qmk.fm) is hosted on [Gitbook](https://www.gitbook.com/book/qmk/firmware/details) and [GitHub](/docs/) (they are synced). You can request changes by making a fork and [pull request](https://github.com/qmk/qmk_firmware/pulls), or by clicking the "suggest an edit" link on any page of the Docs. +[http://qmk.fm](http://qmk.fm) is the official website of QMK, where you can find links to this page, the documentation, and the keyboards supported by QMK. |