From 1fc38053926c8f1f3129e4e12826e05458375c85 Mon Sep 17 00:00:00 2001 From: Niklas Hauser Date: Thu, 18 Feb 2021 17:56:24 +0100 Subject: [PATCH] [docs] Fix example docs --- examples/README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/examples/README.md b/examples/README.md index 4cc84b31a4..8622c4497b 100644 --- a/examples/README.md +++ b/examples/README.md @@ -10,7 +10,10 @@ Make sure you've [installed all tools required for building modm](https://modm.i ## TL;DR +To compile any example: + ``` +cd modm/examples/generic/blinky # cd into the example lbuild build # generate modm library (call only once) scons program # compile and upload to your development board ``` @@ -19,7 +22,7 @@ To debug with GDB in TUI mode: ``` scons program profile=debug # compile and upload debug profile -scons gdb profile=debug # launch OpenOCD and GDB for debugging +scons debug profile=debug # launch OpenOCD and GDB for debugging ``` To generate your target specific Doxygen documentation: