diff options
Diffstat (limited to 'readme.md')
-rw-r--r-- | readme.md | 36 |
1 files changed, 36 insertions, 0 deletions
diff --git a/readme.md b/readme.md new file mode 100644 index 000000000..5649ddfa0 --- /dev/null +++ b/readme.md | |||
@@ -0,0 +1,36 @@ | |||
1 | # Quantum Mechanical Keyboard Firmware | ||
2 | |||
3 | [](https://github.com/qmk/qmk_firmware/tags) | ||
4 | [](https://discord.gg/Uq7gcHh) | ||
5 | [](https://docs.qmk.fm) | ||
6 | [](https://github.com/qmk/qmk_firmware/pulse/monthly) | ||
7 | [](https://github.com/qmk/qmk_firmware/) | ||
8 | |||
9 | 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). | ||
10 | |||
11 | ## Documentation | ||
12 | |||
13 | * [See the official documentation on docs.qmk.fm](https://docs.qmk.fm) | ||
14 | |||
15 | 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. | ||
16 | |||
17 | 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. | ||
18 | |||
19 | ## Supported Keyboards | ||
20 | |||
21 | * [Planck](/keyboards/planck/) | ||
22 | * [Preonic](/keyboards/preonic/) | ||
23 | * [ErgoDox EZ](/keyboards/ergodox_ez/) | ||
24 | * [Clueboard](/keyboards/clueboard/) | ||
25 | * [Cluepad](/keyboards/clueboard/17/) | ||
26 | * [Atreus](/keyboards/atreus/) | ||
27 | |||
28 | The project also includes community support for [lots of other keyboards](/keyboards/). | ||
29 | |||
30 | ## Maintainers | ||
31 | |||
32 | 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). | ||
33 | |||
34 | ## Official Website | ||
35 | |||
36 | [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. | ||