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