X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;ds=sidebyside;f=Home.md;h=e728e1a4f1624b75f0409bf05c23fb62d3e2fa9b;hb=7da82a68334b9ace1a6e8edf4be3230bbfbc80eb;hp=cc00b2eb338e0eb9b3eca47c82b1ce530ae98c58;hpb=30bf618864b3beb2c141f2db13480bcf08f2a2bd;p=qmk_firmware.git diff --git a/Home.md b/Home.md index cc00b2eb3..e728e1a4f 100644 --- a/Home.md +++ b/Home.md @@ -1,3 +1,7 @@ +# Quantum Mechanical Keyboard Firmware + +You have found the QMK Firmware documentation site. This is a keyboard firmware based on the [tmk_keyboard firmware](http://github.com/tmk/tmk_keyboard) with some useful features for Atmel AVR 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/). It has also been ported to ARM chips using ChibiOS. You can use it to power your own hand-wired or custom keyboard PCB. + # Getting started Before you are able to compile, you'll need to install an environment for AVR development. You'll find the instructions for any OS below. If you find another/better way to set things up from scratch, please consider [making a pull request](https://github.com/qmk/qmk_firmware/pulls) with your changes!