include merged mining work in simulated mining
[p2pool.git] / README
1 Requirements:
2     Generic:
3         Bitcoin >=0.6.4
4         Python
5         Twisted
6         python-argparse (for Python <=2.6)
7     
8     Linux:
9         sudo apt-get install python-zope.interface python-twisted python-twisted-web
10         sudo apt-get install python-argparse # if on Python 2.6 or older
11     
12     Windows:
13         Install Python 2.7: http://www.python.org/getit/
14         Install Twisted: http://twistedmatrix.com/trac/wiki/Downloads
15         Install Zope.Interface: http://pypi.python.org/pypi/zope.interface/3.8.0
16             Unzip the files into C:\Python27\Lib\site-packages
17
18 Running P2Pool:
19     To use P2Pool, you must be running your own local bitcoind. For standard
20     configurations, using P2Pool should be as simple as:
21
22         python run_p2pool.py
23
24     Then run your miner program, connecting to 127.0.0.1 on port 9332 with any
25     username and password.
26
27     If you are behind a NAT, you should enable TCP port forwarding on your
28     router. Forward port 9333 to the host running P2Pool.
29
30     Run "python run_p2pool.py --help" for additional options.
31
32 Donations towards further development:
33     1HNeqi3pJRNvXybNX4FKzZgYJsdTSqJTbk
34
35 Notes for Litecoin:
36     Requirements:
37         In order to run P2Pool with the Litecoin network, you would need to build and install the
38         ltc_scrypt module that includes the scrypt proof of work code that Litecoin uses for hashes.
39
40         Linux:
41             cd litecoin_scrypt
42             sudo python setup.py install
43
44         Windows:
45             Install MinGW: http://www.mingw.org/wiki/Getting_Started
46             Install Python 2.7: http://www.python.org/getit/
47
48             cd litecoin_scrypt
49             C:\Python27\python.exe setup.py build --compile=mingw32 install
50
51             If you run into an error with unrecognized command line option '-mno-cygwin', see this:
52                 http://stackoverflow.com/questions/6034390/compiling-with-cython-and-mingw-produces-gcc-error-unrecognized-command-line-o
53     
54     Running P2Pool:
55         Run P2Pool with the "--net litecoin" option.
56         Run your miner program, connecting to 127.0.0.1 on port 9327.
57         Forward port 9338 to the host running P2Pool.
58         
59         Litecoin's use of ports 9332 and 9332 conflicts with P2Pool running on
60         the Bitcoin network. To avoid problems, add these lines to litecoin.conf
61         and restart litecoind:
62             rpcport=10332
63             port=10333