merged block submittal into one one function
[p2pool.git] / README
diff --git a/README b/README
index 4d52a27..ff2f5fb 100644 (file)
--- a/README
+++ b/README
@@ -1,21 +1,37 @@
+Requirements:
+
+* Bitcoin >=0.5.0
+* Python
+* Twisted
+* python-argparse (for Python <=2.6)
+
+Linux:
+    sudo apt-get install python-zope.interface python-twisted python-twisted-web
+    sudo apt-get install python-argparse # if on Python 2.6 or older
+
+Windows:
+    Install Python 2.7: http://www.python.org/getit/
+    Install Twisted: http://twistedmatrix.com/trac/wiki/Downloads
+    Install Zope.Interface: http://pypi.python.org/pypi/zope.interface/3.8.0
+        unzip the files into C:\Python27\Lib\site-packages
+
+
 To use p2pool, you must be running your own local bitcoind. p2pool connects to
 this bitcoin over both its p2p interface and its RPC interface. For standard
 configurations, using p2p should be as simple as:
 
-    python main.py <rpc_username> <rpc_password>
+    python run_p2pool.py <rpc_username> <rpc_password>
 
-Then run your miner program, connecting to 127.0.0.1 on port 8338 with any
+Then run your miner program, connecting to 127.0.0.1 on port 9332 with any
 username and password.
 
 
-If you are behind a NAT, it will help to enable UDP port forwarding on your
-router. Forward any random port to the host running p2pool.py and then use:
-
-    python main.py -p <PORT> <rpc_username> <rpc_password>
+If you are behind a NAT, it will help to enable TCP port forwarding on your
+router. Forward port 9333 to the host running p2pool.py.
 
 
 Use
 
-    python main.py --help
+    python run_p2pool.py --help
 
 for additional options.