From ca9c10ba632ead044b8a58f13b0f1e031a0fc2b6 Mon Sep 17 00:00:00 2001 From: Michael Kubler Date: Thu, 28 Nov 2013 12:52:55 +1030 Subject: [PATCH] Update README.md Making the makin Github script section into useful bash output for easier reading. There was some commands which were at the end of comments and easy to miss making it hard to get working right. --- README.md | 27 +++++++++++++++------------ 1 file changed, 15 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 54e28a6..42425f0 100644 --- a/README.md +++ b/README.md @@ -14,18 +14,21 @@ Installation using Github ------------------------- This is advanced option for experienced users, but give you the easiest way for updating the proxy. -1. git clone https://github.com/CryptoManiac/stratum-mining-proxy.git -2. cd stratum-mining-proxy -3. sudo apt-get install python-dev # Development package of Python are necessary -4. sudo python distribute_setup.py # This will upgrade setuptools package -5. cd litecoin_scrypt - sudo python setup.py install # Build and install LTC scrypt extension - cd .. -6. sudo python setup.py develop # This will install required dependencies (namely Twisted and Stratum libraries), but don't install the package into the system. -7. You can start the Stratum proxy by typing "./mining_proxy.py" in the terminal window. Using default settings, it connects to Itzod's mining pool. - Also you have ability to start Stratum/LTC proxy by typing "./mining-proxy.py -pa scrypt". Using default settings, it connects to LTCMine mining pool. -8. If you want to connect to another pool or change other proxy settings, type "./mining_proxy.py --help". -9. If you want to update the proxy, type "git pull" in the package directory. +```bash +git clone https://github.com/CryptoManiac/stratum-mining-proxy.git +cd stratum-mining-proxy +sudo apt-get install python-dev # Development package of Python are necessary +sudo python distribute_setup.py # This will upgrade setuptools package +cd litecoin_scrypt +sudo python setup.py install # Build and install LTC scrypt extension +cd .. +sudo python setup.py develop # This will install required dependencies (namely Twisted and Stratum libraries), but don't install the package into the system. +``` + +1. You can start the Stratum proxy by typing "./mining_proxy.py" in the terminal window. Using default settings, it connects to Itzod's mining pool. +2. Also you have ability to start Stratum/LTC proxy by typing "./mining-proxy.py -pa scrypt". Using default settings, it connects to LTCMine mining pool. +3. If you want to connect to another pool or change other proxy settings, type "./mining_proxy.py --help". +4. If you want to update the proxy, type "git pull" in the package directory. Compiling midstate C extension ------------------------------