aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorUwe Hermann2010-01-15 13:33:58 +0100
committerUwe Hermann2010-01-15 13:33:58 +0100
commit99249672d5b46dc6a06ed6a78dd600ba44e78518 (patch)
treec1e3d93912b78bc9d26801139a49f750d7daed4a /README
parent8d1c4649618573fb9d0300a0c074061cb1298bbe (diff)
Document the usage of the example projects.
Diffstat (limited to 'README')
-rw-r--r--README18
1 files changed, 18 insertions, 0 deletions
diff --git a/README b/README
index c206e2b..6f5459a 100644
--- a/README
+++ b/README
@@ -20,6 +20,24 @@ For a more verbose build you can use
$ make V=1
+Example projects
+----------------
+
+The library ships with a few small example projects which illustrate how
+individual subsystems of the SMT32 can be configured and used with
+libopenstm32.
+
+For flashing the 'miniblink' example (after you built libopenstm32 and the
+examples by typing 'make' at the top-level directory) you can execute:
+
+ $ cd examples/miniblink
+ $ make flash
+
+The Makefiles of the examples are configured to use a certain OpenOCD
+flash programmer, you might need to change some of the variables in the
+Makefile if you use a different one.
+
+
Installation
------------