Skip to content

Commit

Permalink
[docs] Fix example docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@salkinium
salkinium committed Feb 26, 2021
1 parent e30fdfd commit 1fc3805
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion examples/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
Expand All @@ -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:
Expand Down

0 comments on commit 1fc3805

Please sign in to comment.