aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-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