summaryrefslogtreecommitdiffstats
path: root/docs/newbs.md
diff options
context:
space:
mode:
authornoroadsleft <18669334+noroadsleft@users.noreply.github.com>2018-10-18 15:12:11 -0700
committerDrashna Jaelre <drashna@live.com>2018-10-18 15:12:11 -0700
commit480651cf9df5c0b7453f60dffe13ae5de665a120 (patch)
tree87954dae9cb04640290e5ddec5be46555a05dcb5 /docs/newbs.md
parent53a43dbe995640632be834f406007a72f8fa4d3e (diff)
Docs: Adding QMK Git Conventions doc; formatting cleanup on Learning Resources doc (#3902)
* Docs: newbs_learn_more_resources.md: formatting * Added QMK Git Conventions doc, initial version * Renamed contributing_qmk.md to newbs_best_practices.md * Updated per review by @drashna * Added navigation links * Updated to Best Practices doc * Minor updates to Learn More Resources doc Markdown formatting consistency because I'm particular about it. * Added Merge Conflict section to Best Practices doc
Diffstat (limited to 'docs/newbs.md')
-rw-r--r--docs/newbs.md1
1 files changed, 1 insertions, 0 deletions
diff --git a/docs/newbs.md b/docs/newbs.md
index 38a9607d44..e687fd2279 100644
--- a/docs/newbs.md
+++ b/docs/newbs.md
@@ -12,6 +12,7 @@ There are 5 main sections to this guide:
* [Building Your First Firmware](newbs_building_firmware.md)
* [Flashing Firmware](newbs_flashing.md)
* [Testing and Debugging](newbs_testing_debugging.md)
+* [Best Practices](newbs_best_practices.md)
* [Learn More with these Resources](newbs_learn_more_resources.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).