aboutsummaryrefslogtreecommitdiff
path: root/examples/README.md
diff options
context:
space:
mode:
authorChristopher Peplin <chris.peplin@rhubarbtech.com>2014-09-09 23:09:35 -0400
committerChristopher Peplin <chris.peplin@rhubarbtech.com>2014-09-09 23:17:15 -0400
commitc86ce093ce93eb8da1136acd1e81973ef0bb54fc (patch)
tree9113fe08113c3548b84ba02b4d55db8cee49395f /examples/README.md
parente30bb5c28a42152007d70325477f364605b73f34 (diff)
Add a script to compile examples as an automated test suite.
* Added script/boostrap.sh to download the Arduino IDE and MPIDE (for chipKIT). Tested in Linux, should work in Cygwin and OS X too. * Added script/runtests.sh to run "make" in each example project and collect the results. The script returns -1 if any fails. * Moved currently testable examples to a "tests" directory, separate from examples that require alternative cores.
Diffstat (limited to 'examples/README.md')
-rw-r--r--examples/README.md10
1 files changed, 7 insertions, 3 deletions
diff --git a/examples/README.md b/examples/README.md
index b170cdc..39425b3 100644
--- a/examples/README.md
+++ b/examples/README.md
@@ -1,7 +1,11 @@
-This folder contains the list of example Arduino sketches and makefile showing the different usage patterns
+This folder contains the list of example Arduino sketches and makefile showing
+the different usage patterns
+
+- BlinkInAVRC - Shows how to use plain AVR C code
+- ATtinyBlink - Shows how to use different cores like ATtiny
+
+These three examples are a step back, in the "tests" directory.
- Blink - Shows normal usage
- HelloWorld - Shows how to include Arduino libraries
-- BlinkInAVRC - Shows how to use plain AVR C code
- BlinkChipKIT - Shows how to use ChipKIT
-- ATtinyBlink - Shows how to use different cores like ATtiny