From: Adriana Draghici <adriana.draghici@cti.pub.ro>
Date: Sun, 11 Apr 2010 09:47:14 +0000 (+0300)
Subject: autorun: added usage details in README.
X-Git-Tag: getopt_long~101
X-Git-Url: http://p2p-next.cs.pub.ro/gitweb/?a=commitdiff_plain;h=647e7dde0659266afa8eceb32c9d7c115dc8a711;p=cs-p2p-next.git

autorun: added usage details in README.
---

diff --git a/autorun/README b/autorun/README
index 9aacb80..5ae9548 100644
--- a/autorun/README
+++ b/autorun/README
@@ -3,7 +3,9 @@ Automated command interface for BitTorrent clients. It Supports starting remotel
 a daemon server, that will receive start/stop commands for the clients from that 
 remote host.
 
-File breakdown:
+*********************************
+*        File breakdown         *
+*********************************
 
 server/
     - Server.py             - server that runs as a daemon
@@ -31,4 +33,24 @@ Util.py - constants used by server and commander.
 PROTOCOL - communication description between Server and Commander
 
 
+*********************************
+*           Usage               *
+*********************************
 
+    - test Commander<->Server
+        1. in xml/nodes.xml add node ip and server listening port 
+        2. in xml/swarm.xml add torrent file
+        3. on remote node, check SERVER_HOST and SERVER_PORT in Util.py. 
+        The Server listens on its vm interface address.
+        4. start commander using commander/run.sh
+
+    - test locally without remotely starting Server:
+        - in server/ :
+        1. python Server.py - output in /home/p2p/out and /home/p2p/err
+           or
+           python Server_NO_DAEMON for console output
+        2. python Client.py torrent_path
+            - has test scenerios for tribler, transmission and hrktorrent. 
+            - modify test_all_commands method in order to choose the BT client.
+
+