cleaned up ChecksummedType
[p2pool.git] / README-Litecoin
1 In order to run p2pool with the Litecoin network, you would need to build and install the
2 ltc_scrypt module that includes the scrypt proof of work code that Litecoin uses for hashes.
3
4 Linux:
5     sudo apt-get install python-zope.interface
6     sudo apt-get install python-twisted
7     sudo apt-get install python-twisted-web
8     sudo apt-get install python-argparse (if on Python 2.6 or older)
9     cd litecoin_scrypt
10     sudo python setup.py install
11
12 Windows:
13     Install MinGW: http://www.mingw.org/wiki/Getting_Started
14     Install Python 2.7: http://www.python.org/getit/
15     Install Twisted: http://twistedmatrix.com/trac/wiki/Downloads
16     Install Zope.Interface: http://pypi.python.org/pypi/zope.interface/3.8.0
17         unzip the files into C:\Python27\Lib\site-packages
18
19     cd litecoin_scrypt
20     C:\Python27\python.exe setup.py build --compile=mingw32 install
21
22     If you run into an error with unrecognized command line option '-mno-cygwin', see this:
23         http://stackoverflow.com/questions/6034390/compiling-with-cython-and-mingw-produces-gcc-error-unrecognized-command-line-o
24
25 To use p2pool, you must be running your own local litecoind. p2pool connects to
26 this litecoin over both its p2p interface and its RPC interface. For standard
27 configurations, using p2p should be as simple as:
28
29     python run_p2pool.py --net litecoin <rpc_username> <rpc_password>
30
31 Then run your miner program, connecting to 127.0.0.1 on port 9327 (19327 for testnet) with any
32 username and password.
33
34
35 If you are behind a NAT, it will help to enable TCP port forwarding on your
36 router. Forward port 9338 (19338 for testnet) to the host running p2pool.py.
37
38
39 Use
40
41     python run_p2pool.py --help
42
43 for additional options.