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