diff options
Diffstat (limited to 'docs/README.md')
| -rw-r--r-- | docs/README.md | 22 |
1 files changed, 8 insertions, 14 deletions
diff --git a/docs/README.md b/docs/README.md index d6cde53c9..9330f0fac 100644 --- a/docs/README.md +++ b/docs/README.md | |||
| @@ -1,26 +1,20 @@ | |||
| 1 | # Quantum Mechanical Keyboard Firmware | 1 | # Quantum Mechanical Keyboard Firmware |
| 2 | 2 | ||
| 3 | [](https://github.com/qmk/qmk_firmware/tags) | ||
| 4 | [](https://travis-ci.org/qmk/qmk_firmware) | ||
| 5 | [](https://discord.gg/Uq7gcHh) | ||
| 6 | [](https://docs.qmk.fm) | ||
| 7 | [](https://github.com/qmk/qmk_firmware/pulse/monthly) | ||
| 8 | [](https://github.com/qmk/qmk_firmware/) | ||
| 9 | |||
| 10 | ## What is QMK Firmware? | 3 | ## What is QMK Firmware? |
| 11 | 4 | ||
| 12 | QMK (*Quantum Mechanical Keyboard*) is an open source community centered around developing computer input devices. The community encompasses all sorts of input devices, such as keyboards, mice, and MIDI devices. A core group of collaborators maintains [QMK Firmware](https://github.com/qmk/qmk_firmware), [QMK Configurator](https://config.qmk.fm), [QMK Toolbox](https://github.com/qmk/qmk_toolbox), [qmk.fm](https://qmk.fm), and this documentation with the help of community members like you. | 5 | QMK (*Quantum Mechanical Keyboard*) is an open source community centered around developing computer input devices. The community encompasses all sorts of input devices, such as keyboards, mice, and MIDI devices. A core group of collaborators maintains [QMK Firmware](https://github.com/qmk/qmk_firmware), [QMK Configurator](https://config.qmk.fm), [QMK Toolbox](https://github.com/qmk/qmk_toolbox), [qmk.fm](https://qmk.fm), and this documentation with the help of community members like you. |
| 13 | 6 | ||
| 14 | ## Get Started | 7 | ## Get Started |
| 15 | 8 | ||
| 16 | Totally new to QMK? There are two ways to get started: | 9 | <div class="flex-container"> |
| 10 | |||
| 11 | ?> **Basic** [QMK Configurator](newbs_building_firmware_configurator.md) <br> | ||
| 12 | User friendly graphical interfaces, no programming knowledge required. | ||
| 13 | |||
| 14 | ?> **Advanced** [Use The Source](newbs.md) <br> | ||
| 15 | More powerful, but harder to use. | ||
| 17 | 16 | ||
| 18 | * Basic: [QMK Configurator](https://config.qmk.fm) | 17 | </div> |
| 19 | * Just select your keyboard from the dropdown and program your keyboard. | ||
| 20 | * We have an [introductory video](https://www.youtube.com/watch?v=-imgglzDMdY) you can watch. | ||
| 21 | * There is also an overview [document you can read](newbs_building_firmware_configurator.md). | ||
| 22 | * Advanced: [Use The Source](newbs.md) | ||
| 23 | * More powerful, but harder to use | ||
| 24 | 18 | ||
| 25 | ## Make It Yours | 19 | ## Make It Yours |
| 26 | 20 | ||