gitbot
/
qmk_firmware
mirror of https://github.com/qmk/qmk_firmware
0
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
qmk_firmware/readme.md

33 lines
2.2 KiB
Markdown
Raw Normal View History

updates README, fixes typo in new_project.sh
2016-04-26 17:44:27 +00:00
# Quantum Mechanical Keyboard Firmware
Made directories for keyboard and converter projects.
2012-06-07 15:37:46 +00:00
Update readme.md
2017-08-03 15:57:18 +00:00
[![Current Version](https://img.shields.io/github/tag/qmk/qmk_firmware.svg)](https://github.com/qmk/qmk_firmware/tags)
Update readme.md
2017-05-20 16:37:31 +00:00
[![Build Status](https://travis-ci.org/qmk/qmk_firmware.svg?branch=master)](https://travis-ci.org/qmk/qmk_firmware)
[![Gitter](https://img.shields.io/gitter/room/qmk/qmk_firmware.js.svg)](https://gitter.im/qmk/qmk_firmware)
[![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/)
adds author block to readme
2016-06-22 18:30:47 +00:00
Update readme.md
2017-05-20 16:37:31 +00:00
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/).
README
2015-10-28 17:58:21 +00:00
Update readme.md
2017-05-20 16:37:31 +00:00
## Official website
Updates overall readme
2016-06-23 03:24:47 +00:00
Update readme.md
2017-05-20 16:37:31 +00:00
[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.
Updates overall readme
2016-06-23 03:24:47 +00:00
Update readme.md
2017-05-20 16:37:31 +00:00
## Supported Keyboards
Updates overall readme
2016-06-23 03:24:47 +00:00
* [Planck](/keyboards/planck/)
* [Preonic](/keyboards/preonic/)
Fix broken link
2017-08-24 11:17:31 +00:00
* [ErgoDox EZ](/keyboards/ergodox_ez/)
Fix Clueboard readme links (#1816)
2017-10-06 20:36:35 +00:00
* [Clueboard](/keyboards/clueboard_66/)
* [Cluepad](/keyboards/clueboard_17/)
Updates overall readme
2016-06-23 03:24:47 +00:00
The project also includes community support for [lots of other keyboards](/keyboards/).
## Maintainers
Update readme.md
2017-05-20 16:37:31 +00:00
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).
Updates readme.md Auto commit by GitBook Editor
2017-05-13 18:25:08 +00:00
Update readme.md
2017-05-20 16:37:31 +00:00
## Documentation
Updates readme.md Auto commit by GitBook Editor
2017-05-13 18:25:08 +00:00
Improvements to documentation (#1919) * Typo: Github => GitHub * Typo: windows => Windows, docker => Docker, and some punctuations * "QMK Introduction" links to the right file * "Unix" rather than "UNIX", which is a trademark * Directory name is "keyboards", not "keyboard" * "handwired" is a subdirectory of "keyboards" * Punctuation and minor fixes * macOS rather than Mac * Punctuation and other minor fixes * Vagrant Guide links to an existing file * Jun Wako referenced with his name rather than his nickname * Saxon genitive 's outside the link
2017-11-01 15:21:54 +00:00
[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.