diff options
| author | Joel Challis <git@zvecr.com> | 2021-01-20 18:46:01 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-01-20 18:46:01 +0000 |
| commit | 4e8166750b21cfd3feaba0d6024087fb5c76bca9 (patch) | |
| tree | c124714e565321818485b96509fd70026fe49f84 /docs/README.md | |
| parent | 1328ab7c7defdca40872273147f387618b1a48c3 (diff) | |
Small tweaks to docs to make them more user friendly (#11518)
* first pass
* firmware firmware?
* Split out debug + testing docs
* tidy up duplicate css
* Add extra info to debug example
Co-authored-by: Drashna Jaelre <drashna@live.com>
Co-authored-by: Drashna Jaelre <drashna@live.com>
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 d6cde53c90..9330f0face 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,26 +1,20 @@ # Quantum Mechanical Keyboard Firmware -[](https://github.com/qmk/qmk_firmware/tags) -[](https://travis-ci.org/qmk/qmk_firmware) -[](https://discord.gg/Uq7gcHh) -[](https://docs.qmk.fm) -[](https://github.com/qmk/qmk_firmware/pulse/monthly) -[](https://github.com/qmk/qmk_firmware/) - ## What is QMK Firmware? 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. ## Get Started -Totally new to QMK? There are two ways to get started: +<div class="flex-container"> + +?> **Basic** [QMK Configurator](newbs_building_firmware_configurator.md) <br> +User friendly graphical interfaces, no programming knowledge required. + +?> **Advanced** [Use The Source](newbs.md) <br> +More powerful, but harder to use. -* Basic: [QMK Configurator](https://config.qmk.fm) - * Just select your keyboard from the dropdown and program your keyboard. - * We have an [introductory video](https://www.youtube.com/watch?v=-imgglzDMdY) you can watch. - * There is also an overview [document you can read](newbs_building_firmware_configurator.md). -* Advanced: [Use The Source](newbs.md) - * More powerful, but harder to use +</div> ## Make It Yours |