aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorBarattero Laurent <laurent@larueluberlu.net>2024-10-06 22:22:06 +0200
committerBarattero Laurent <laurent@larueluberlu.net>2024-10-06 22:22:06 +0200
commit1742fe7d6f81169a5182e459dd45e51a69181ef0 (patch)
tree4dfa824ea105de42d63d2a01608f2a5f08dc7880 /README.md
parent49fe49f7f0c6ad3ec81fbcbcd266ce627379182a (diff)
Chiefly, fixed the bug that blocked the compilation.HEADmaster
Also, update of atoreconf, readme, man, exemples, help...
Diffstat (limited to 'README.md')
-rw-r--r--README.md48
1 files changed, 35 insertions, 13 deletions
diff --git a/README.md b/README.md
index d414fa7..25f6729 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,8 @@
-README for AeroUp 0.3.1
+README for AeroUp 0.3.2
=======================
-AeroUp is an open source and multiplatform tool to control Ultimate (programmable light sequencing juggling props) from Aerotech Projects.
-
-There is not yet support for microsoft Window, because as i working on the core part who'll become a shared lib,
-and there is no support for getoptlong for Window, as a Qt gui is scheduled soon, i don't bother me.
+AeroUp is an open source tool to control the "old" but brave Ultimate (programmable light sequencing juggling props) from Aerotech Projects on GNU/Linux.
Features
@@ -18,8 +15,7 @@ Features
* Upload glo sequences command
* Improved driver (udev linux)
* Checks syntax of .glo files
-
-Multiplatform gui, and some others original features coming soon...
+* And more...
Installation
@@ -35,18 +31,44 @@ Installation
If you have boost library it will use it.
But it should not be a problem if you don't have it.
+
Documentation
=============
```
man aeroup
```
-Or look at the man folder :
-https://github.com/LaurentBa/AeroUp/blob/master/man/aeroup.man.txt
+A text version is available in the sources :
+https://git.larueluberlu.net/AeroUp/tree/man/aeroup.man.txt
+
+
+Exemple
+=======
+```
+# Test prop on /dev/ttyACM0
+aeroup -t /dev/ttyACM0
+
+# Start props on /dev/ttyACM0 et /dev/tty/ACM1 and test /dev/tty/ACM3
+aeroup -o /dev/ttyACM0 -o /dev/ttyACM1 -t /dev/ttyACM3
+
+# Set color to blue and red
+aeroup -c O,O,255,/dev/ttyACM0 255,0,0,/dev/ttyACM1
+
+# Upload file.glo to /devttyACMO
+aeroup -u /path/to/file.glo,/dev/ttyACM0
+
+# Set serial number 0x7002 to have a prop named Poi2
+aeroup -S 0x7002,/dev/ttyACM0
+
+# Verify your serial number is now : 0x7002
+aeroup -G /dev/ttyACM0
+
+# Verify your serial name is Poi2
+aeroup -k /dev/ttyACM0
+```
+
Links
=====
-* Github page : https://github.com/LaurentBa/AeroUp
-* http://www.aerotechprojects.com/index.htm
-
-note : there will be no support for microsoft Window before version 1
+* Git page : https://git.larueluberlu.net/AeroUp
+* Cie La rue Luberlu : https://larueluberlu.net