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/newbs.md | 14 ++++---------- 1 file changed, 4 insertions(+), 10 deletions(-) (limited to 'docs/newbs.md') diff --git a/docs/newbs.md b/docs/newbs.md index 02b0a070f5..4bf5180265 100644 --- a/docs/newbs.md +++ b/docs/newbs.md @@ -6,25 +6,19 @@ QMK tries to put a lot of power into your hands by making easy things easy, and Not sure if your keyboard can run QMK? If it's a mechanical keyboard you built yourself chances are good it can. We support a [large number of hobbyist boards](http://qmk.fm/keyboards/). If your current keyboard can't run QMK there are a lot of choices out there for boards that do. -## Is This Guide For Me? - -This guide is suitable for everyone who wants to build a keyboard firmware using the source code. If you are already a programmer you will find the process very familiar and easier to follow. If the thought of programming intimidates you please [take a look at our online GUI](newbs_building_firmware_configurator.md) instead. +?> **Is This Guide For Me?**
+If the thought of programming intimidates you, please [take a look at our online GUI](newbs_building_firmware_configurator.md) instead. ## Overview -There are 4 main sections to this guide: +This guide is suitable for everyone who wants to build a keyboard firmware using the source code. If you are already a programmer you will find the process very familiar and easier to follow. There are 3 main sections to this guide: 1. [Setup Your Environment](newbs_getting_started.md) 2. [Building Your First Firmware](newbs_building_firmware.md) 3. [Flashing Firmware](newbs_flashing.md) -4. [Testing and Debugging](newbs_testing_debugging.md) This guide is focused on helping someone who has never compiled software before. It makes choices and recommendations based on that viewpoint. There are alternative methods for many of these procedures, and we support most of those alternatives. If you have any doubt about how to accomplish a task you can [ask us for guidance](getting_started_getting_help.md). ## Additional Resources -Beyond this guide there are several resources you may find helpful while you learn QMK. We've collected them on the [Learning Resources](newbs_learn_more_resources.md) page. - -## Open Source - -QMK is Open Source Software released under the GNU General Public License. +Beyond this guide there are several resources you may find helpful while you learn QMK. We've collected them on the [Syllabus](syllabus.md) and [Learning Resources](newbs_learn_more_resources.md) pages. -- cgit v1.2.3