modified autorun/README
authorAdriana Draghici <adriana.draghici@cti.pub.ro>
Sat, 10 Apr 2010 09:39:33 +0000 (12:39 +0300)
committerAdriana Draghici <adriana.draghici@cti.pub.ro>
Sat, 10 Apr 2010 09:39:41 +0000 (12:39 +0300)
autorun/README

index 0c39fa2..9aacb80 100644 (file)
@@ -1,30 +1,33 @@
 
+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.
 
 File breakdown:
 
 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
-                 - usage: python Client.py torrent_file
-    - BitTorrentClientRun - starts BitTorrent clients
-    - *Run.py - classes tha extend BitTorrentClientRun, specific to
-                each type of BitTorrent client.
+    - 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
+                            - usage: python Client.py torrent_file
+    - BitTorrentClientRun   - starts BitTorrent clients
+    - *Run.py               - classes tha extend BitTorrentClientRun, specific to
+                            each type of BitTorrent client.
 
 commander/ - 
-    - Client.py - commands the server
+    - Client.py         - commands the server
     - ParserConf.py 
-    - SSHCommander.py - connects and sends remote commands via SSH 
+    - SSHCommander.py   - connects and sends remote commands via SSH 
     - TrafficControl.py - traffic control interface for Linux tc
-    - XMLParser.py - parse configuration files from ../xml
+    - XMLParser.py      - parse configuration files from ../xml
     - run.sh
 
-xml/ - xml files with information 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.
+
 PROTOCOL - communication description between Server and Commander