Skip to content

Commit 918b9bd

Browse files
committed
doc: add README.md to the example
1 parent 4f5bdf4 commit 918b9bd

1 file changed

Lines changed: 13 additions & 0 deletions

File tree

examples/default/README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
## What the example does
2+
3+
* Initializes the driver
4+
* Configure a pin as input
5+
* Registers an interrupt that logs port value of the INT pin
6+
* Blinks, or toggles, P10 output
7+
8+
## Wiring
9+
10+
Connect an LED with an appropriate register to P10.
11+
12+
Connect a switch that toggle its voltage HIGH or LOW to INT GPIO. The INT GPIO
13+
can be set in `menuconfig`. See the defaults in `Kconfig.projbuild`.

0 commit comments

Comments
 (0)