]> git.parisson.com Git - piplayer.git/commitdiff
add prop info
authorGuillaume Pellerin <yomguy@parisson.com>
Sun, 28 Jul 2013 09:27:46 +0000 (11:27 +0200)
committerGuillaume Pellerin <yomguy@parisson.com>
Sun, 28 Jul 2013 09:27:46 +0000 (11:27 +0200)
README.md

index f74b16008bc2c288b565971cb9128221bc00c57a..621c46616bbce1ccf80a45f2f14036d18178617f 100644 (file)
--- a/README.md
+++ b/README.md
@@ -9,14 +9,7 @@ Usage
 ------
 
 ```
-  $ sudo piplayer DIR
-```
-
-Example
-------------
-
-```
-  $ sudo piplayer /path/to/dir/
+  $ sudo piplayer /path/to/dir
 ```
 
 OSC
@@ -24,14 +17,15 @@ OSC
 
  * port : 12345
  * play address : /play/1
+ * stop address : /play/0
  
 GPIO
 -----
 
  * play channel : 22
- * play method : PUD_DOWN between PIN 1 (3.3V Power) and PIN 15 (GPIO 22)
+ * play method : PUD_DOWN between PIN 1 (3.3V power) and PIN 15 (GPIO 22)
  * stop channel : 24
- * stop method : PUD_DOWN between PIN 1 (3.3V Power) and PIN 18 (GPIO 24)
+ * stop method : PUD_DOWN between PIN 1 (3.3V power) and PIN 18 (GPIO 24)
 
 INSTALL
 --------
@@ -49,14 +43,17 @@ DAEMON
 -------
 
 ```
- $ cp -ra etc/* /etc/
- $ update-rc.d piplayer defaults 5 1
+ $ sudo cp -ra etc/* /etc/
+ $ sudo update-rc.d piplayer defaults 5 1
 ```
 
+Override daemon start and options by editing /etc/default/piplayer
+
+
 OPTIONS
 --------
 
-Some properties and options (like "auto next" and "looping") are tunable in the PiPlayer class:
+Some properties (ports, channels) and options (like "auto next" and "looping") are tunable in the PiPlayer class:
 
 ```
 class PiPlayer(object):