From 4e8166750b21cfd3feaba0d6024087fb5c76bca9 Mon Sep 17 00:00:00 2001 From: Joel Challis Date: Wed, 20 Jan 2021 18:46:01 +0000 Subject: 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 Co-authored-by: Drashna Jaelre --- docs/README.md | 22 ++++++++-------------- 1 file changed, 8 insertions(+), 14 deletions(-) (limited to 'docs/README.md') 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 -[![Current Version](https://img.shields.io/github/tag/qmk/qmk_firmware.svg)](https://github.com/qmk/qmk_firmware/tags) -[![Build Status](https://travis-ci.org/qmk/qmk_firmware.svg?branch=master)](https://travis-ci.org/qmk/qmk_firmware) -[![Discord](https://img.shields.io/discord/440868230475677696.svg)](https://discord.gg/Uq7gcHh) -[![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/) - ## 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: +
+ +?> **Basic** [QMK Configurator](newbs_building_firmware_configurator.md)
+User friendly graphical interfaces, no programming knowledge required. + +?> **Advanced** [Use The Source](newbs.md)
+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 +
## Make It Yours -- cgit v1.2.3