autorun: add Prerequsitest to README
authorRazvan Deaconescu <razvan.deaconescu@cs.pub.ro>
Thu, 15 Apr 2010 08:42:36 +0000 (11:42 +0300)
committerRazvan Deaconescu <razvan.deaconescu@cs.pub.ro>
Thu, 15 Apr 2010 08:43:16 +0000 (11:43 +0300)
autorun/README

index 86818f1..ef5228c 100644 (file)
@@ -1,7 +1,11 @@
+Automated command interface for BitTorrent clients. It Supports starting
+remotely a daemon server, that will receive start/stop commands for the
+clients from that remote host.
 
-Automated command interface for BitTorrent clients. It Supports starting remotely
-a daemon server, that will receive start/stop commands for the clients from that 
-remote host.
+Prerequisites
+
+* python-paramiko (http://www.lag.net/paramiko/): SSH2 for Python
+* python-lxml: Python bindings for libxml2 and libxslt
 
 *********************************
 *        File breakdown         *
@@ -10,13 +14,14 @@ remote host.
 server/
     - Server.py             - server that runs as a daemon
     - Server_NO_DAEMON.py   - server used for testing, not a daemon
-                            - has the same content as Server.py except the daemon 
-                            part
-    - Client.py             - tests the socket based communication with the server
+                           - has the same content as Server.py except
+                               the daemon part
+    - Client.py             - tests the socket based communication with
+                               the server
                             - usage: python Client.py torrent_file
     - BitTorrentClientRun   - starts BitTorrent clients
-    - *Run.py               - classes tha extend BitTorrentClientRun, specific to
-                            each type of BitTorrent client.
+    - *Run.py               - classes tha extend BitTorrentClientRun,
+                               specific to each type of BitTorrent client.
 
 commander/ - 
     - Client.py         - commands the server
@@ -26,7 +31,8 @@ commander/ -
     - XMLParser.py      - parse configuration files from ../xml
     - run.sh
 
-xml/- xml files with data about the infrastructure, BitTorrent clients and swarms
+xml/ - xml files with data about the infrastructure, BitTorrent clients
+and swarms
 
 Util.py - constants used by server and commander.
 
@@ -50,5 +56,5 @@ PROTOCOL - communication description between Server and Commander
            or
            python Server_NO_DAEMON for console output
         2. python Client.py torrent_path
-            - has test scenerios for tribler, transmission and hrktorrent. 
+            - has test scenerios for tribler, transmission and hrktorrent.
             - modify test_all_commands method in order to choose the BT client.