aboutsummaryrefslogtreecommitdiff
path: root/dev/arduino-terminal/README.md
diff options
context:
space:
mode:
authorJakob Odersky <jakob@odersky.com>2016-01-24 20:21:17 -0800
committerJakob Odersky <jakob@odersky.com>2016-02-03 20:46:28 -0800
commitf865a76c2f441f619b069505b73fcbd1cba1a67c (patch)
tree3f53c519f4575037bdebf8c8399ca25d50649543 /dev/arduino-terminal/README.md
parent46c30908f827e27b58166f56efa4f15917c1af4f (diff)
downloadakka-serial-f865a76c2f441f619b069505b73fcbd1cba1a67c.tar.gz
akka-serial-f865a76c2f441f619b069505b73fcbd1cba1a67c.tar.bz2
akka-serial-f865a76c2f441f619b069505b73fcbd1cba1a67c.zip
Add support for Akka streams
Diffstat (limited to 'dev/arduino-terminal/README.md')
-rw-r--r--dev/arduino-terminal/README.md37
1 files changed, 37 insertions, 0 deletions
diff --git a/dev/arduino-terminal/README.md b/dev/arduino-terminal/README.md
new file mode 100644
index 0000000..fae3f72
--- /dev/null
+++ b/dev/arduino-terminal/README.md
@@ -0,0 +1,37 @@
+# Arduino Echo Terminal
+
+Sample code for an echo terminal. The program listens on UART0, baud rate 115200 and echos any data back to the sender, prefixed with "echo: ".
+
+By default, the project is configured for the Arduino Mega series, please see the Makefile for any customization.
+
+## Dependencies
+
+- avr-gcc toolchain
+- avrdude
+
+Note: Arduino source files included, no need to install the Arduino IDE.
+
+## Directory structure
+
+- ext: external sources and headers (i.e. arduino files)
+- src: project-specific sources
+- include: project-specific header files
+
+## Main targets
+- all: compile, link and create a firmware image (intel hex format)
+- upload: call `avrdude` to upload firmware to device
+- monitor: call `cu` to connect to device through serial interface
+- clean: delete any temporary files
+
+## Copying
+This project includes Arduino source files in `ext/arduino`.
+
+Arduino is an open source project, supported by many.
+
+The Arduino team is composed of Massimo Banzi, David Cuartielles, Tom Igoe and David A. Mellis.
+
+Arduino uses GNU avr-gcc toolchain, GCC ARM Embedded toolchain, avr-libc, avrdude, bossac, openOCD and code from Processing and Wiring.
+
+Icon and about image designed by ToDo
+
+Released under the GNU General Public License.