From 99249672d5b46dc6a06ed6a78dd600ba44e78518 Mon Sep 17 00:00:00 2001
From: Uwe Hermann <uwe@hermann-uwe.de>
Date: Fri, 15 Jan 2010 13:33:58 +0100
Subject: [PATCH] Document the usage of the example projects.

---
 README | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/README b/README
index c206e2b7..6f5459aa 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
 ------------