Readme update
[p2pool.git] / README.md
1 Requirements:
2 -------------------------
3 Generic:
4 * Novacoin >=0.4.4.6
5 * Python >=2.6
6 * Twisted >=10.0.0
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
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 * Install python win32 api: http://sourceforge.net/projects/pywin32/files/pywin32/Build%20218/
18 * Install python win32 api wmi wrapper: https://pypi.python.org/pypi/WMI/#downloads
19 * Unzip the files into C:\Python27\Lib\site-packages
20
21 Running P2Pool:
22 -------------------------
23 In order to run P2Pool with the Novacoin network, you would need to build and install the
24 ltc_scrypt module that includes the scrypt proof of work code that Novacoin uses for hashes.
25
26 Linux:
27
28     cd litecoin_scrypt
29     sudo python setup.py install
30
31 Windows (mingw):
32 * Install MinGW: http://www.mingw.org/wiki/Getting_Started
33 * Install Python 2.7: http://www.python.org/getit/
34
35 In bash type this:
36
37     cd litecoin_scrypt
38     C:\Python27\python.exe setup.py build --compile=mingw32 install
39
40 Windows (microsoft visual c++)
41 * Open visual studio console
42
43 In bash type this:
44
45     SET VS90COMNTOOLS=%VS110COMNTOOLS%             # For visual c++ 2012
46     SET VS90COMNTOOLS=%VS100COMNTOOLS%             # For visual c++ 2010
47     cd litecoin_scrypt
48     C:\Python27\python.exe setup.py build --compile=mingw32 install
49
50 If you run into an error with unrecognized command line option '-mno-cygwin', see this:
51 http://stackoverflow.com/questions/6034390/compiling-with-cython-and-mingw-produces-gcc-error-unrecognized-command-line-o
52
53 To use P2Pool, you must be running your own local bitcoind. For standard
54 configurations, using P2Pool should be as simple as:
55
56     python run_p2pool.py
57
58 Then run your miner program, connecting to 127.0.0.1 on port 8336 with any
59 username and password.
60
61 If you are behind a NAT, you should enable TCP port forwarding on your
62 router. Forward port 8777 to the host running P2Pool.
63
64 Run for additional options.
65
66     python run_p2pool.py --help
67
68 Donations towards further development:
69 -------------------------
70     4FuBfHMoSZ7fvQpwGyt6WoCmejEdHKHzLS
71
72 Official wiki :
73 -------------------------
74 https://en.bitcoin.it/wiki/P2Pool
75
76 Alternate web front end :
77 -------------------------
78 * https://github.com/hardcpp/P2PoolExtendedFrontEnd