summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README40
1 files changed, 40 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..13d7667
--- /dev/null
+++ b/README
@@ -0,0 +1,40 @@
+r2d2
+====
+
+ Simple command to execute configured animations on the Sphero R2-D2.
+ Based on the discoveries recorded at:
+
+ http://www.synack.net/~bbraun/spherodroid/
+
+Building
+========
+
+ Run make to build. Requires the BlueZ bluetooth library.
+
+Usage
+=====
+
+ r2d2 [-a address] command [..command]
+
+ If the address is not passed (-a) then the address is taken from the
+ environment variable R2D2 if defined.
+
+ Available commands are:
+
+ laugh
+ yes
+ no
+ alarm
+ angry
+ annoyed
+ ionblast
+ sad
+ scared
+ chatty
+ confident
+ excited
+ happy
+ laugh
+ surprise
+ tripod
+ bipod