X-Git-Url: https://git.novaco.in/?a=blobdiff_plain;f=README;h=8ecc0cc605a4aff22e639b9ca22e9b4ec46f0506;hb=4a00d3522ffb3a90cc5d1deff54de850bce60f82;hp=ff2f5fbca4f9f5e051677a3799a2cf157abd3cc5;hpb=1f5c4869d024eedbf7f9bd3b43368c18de2ebbb7;p=p2pool.git

diff --git a/README b/README
index ff2f5fb..8ecc0cc 100644
--- a/README
+++ b/README
@@ -1,37 +1,60 @@
 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 run_p2pool.py <rpc_username> <rpc_password>
-
-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 TCP port forwarding on your
-router. Forward port 9333 to the host running p2pool.py.
-
-
-Use
-
-    python run_p2pool.py --help
-
-for additional options.
+    Generic:
+        Bitcoin >=0.5.0 or Litecoin
+        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
+
+Running P2Pool:
+    To use P2Pool, you must be running your own local bitcoind. For standard
+    configurations, using P2Pool should be as simple as:
+
+        python run_p2pool.py
+
+    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, you should enable TCP port forwarding on your
+    router. Forward port 9333 to the host running P2Pool.
+
+    Run "python run_p2pool.py --help" for additional options.
+
+Notes for Litecoin:
+    Requirements:
+        In order to run P2Pool with the Litecoin network, you would need to build and install the
+        ltc_scrypt module that includes the scrypt proof of work code that Litecoin uses for hashes.
+
+        Linux:
+            cd litecoin_scrypt
+            sudo python setup.py install
+
+        Windows:
+            Install MinGW: http://www.mingw.org/wiki/Getting_Started
+            Install Python 2.7: http://www.python.org/getit/
+
+            cd litecoin_scrypt
+            C:\Python27\python.exe setup.py build --compile=mingw32 install
+
+            If you run into an error with unrecognized command line option '-mno-cygwin', see this:
+                http://stackoverflow.com/questions/6034390/compiling-with-cython-and-mingw-produces-gcc-error-unrecognized-command-line-o
+    
+    Running P2Pool:
+        Run P2Pool with the "--net litecoin" option.
+        Run your miner program, connecting to 127.0.0.1 on port 9327.
+        Forward port 9338 to the host running P2Pool.
+        
+        Litecoin's use of ports 9332 and 9332 conflicts with P2Pool running on
+        the Bitcoin network. To avoid problems, add these lines to litecoin.conf
+        and restart litecoind:
+            rpcport=10332
+            port=10333