summaryrefslogtreecommitdiff
path: root/examples/README
diff options
context:
space:
mode:
authorPaulo Borges <paulo.borges@openbossa.org>2013-11-30 19:39:50 -0300
committerPaulo Borges <paulo.borges@openbossa.org>2013-12-22 22:43:06 -0300
commit3e8a65adb087ac5f0e670e559ba2e1a1b4c1f013 (patch)
treeeda63e6353dfb147385e4e5fb47334ea536e1e3a /examples/README
parent48523e19d22e82726d6b692185df33ed07a3eb4e (diff)
examples: Add README file
This patch adds a README file with instructions to build & install the examples.
Diffstat (limited to 'examples/README')
-rw-r--r--examples/README8
1 files changed, 8 insertions, 0 deletions
diff --git a/examples/README b/examples/README
new file mode 100644
index 0000000..6746dd6
--- /dev/null
+++ b/examples/README
@@ -0,0 +1,8 @@
+HOW TO BUILD EXAMPLES
+=====================
+
+Every example has a dedicated folder inside `examples` directory. To build an
+example, you must execute `make` specifying the target platform. For example:
+
+ $ cd examples/some-example
+ $ make PLATFORM=my-platform