aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJakob Odersky <jodersky@gmail.com>2015-01-20 16:58:47 +0100
committerJakob Odersky <jodersky@gmail.com>2015-01-20 16:58:47 +0100
commit63586569a4cffdca4c1caf303e2db1a917045410 (patch)
treeaa5bffd4f116f6d400c60cedc8f5be05cf5ea750
parent94ae46fcd95316ccab50c59fc89517fe682d4c94 (diff)
downloadmaverick-63586569a4cffdca4c1caf303e2db1a917045410.tar.gz
maverick-63586569a4cffdca4c1caf303e2db1a917045410.tar.bz2
maverick-63586569a4cffdca4c1caf303e2db1a917045410.zip
add readme
-rw-r--r--README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c0a97c3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,10 @@
+# Maverick
+Maverick is a simple gamepad controller that outputs messages according to the mavlink protocol.
+It can be used as a remote control for UAVs.
+
+Maverick only prints control messages to stdout, transport is left up to other mechanisms.
+E.g. redirecting output to a serial port:
+```./maverick > /sev/ttyUSB0```
+
+## Dependencies
+ - SDL \ No newline at end of file