Updated docs.

This commit is contained in:
donSchoe 2013-10-28 15:33:15 +01:00
parent 5ab03326e7
commit b73825d461
4 changed files with 35 additions and 189 deletions

View file

@ -1,9 +1,14 @@
Primecoin High Performance Version
==================================
Xolominer Documentation
=======================
This is the high performance version of Sunny King's Primecoin tree.
This is the xolominer based on the primecoin high performance version of Sunny King's Primecoin tree.
Features:
Xolominer features:
- pooled mining client
- getwork-protocol (with longpoll-support)
- code integration into original client
Primecoin tree features:
* Use GMP for bignum calculations in the mining threads
* Replaced some bignum calculations with 64-bit arithmetic inside the sieve
* Reduced the amount of memory allocations
@ -11,98 +16,23 @@ Features:
* Process only 10% of base primes when weaving the sieve
* Configurable sieve size
Donations are welcome if you want to support my work.
Usage
-----
BTC: 1EaHwHBWeoJtSM2jEdx9Su1NcKvdXbsqxX
LTC: LPD1zDChmqcqKGHFHuLX2JWMMEC5jD5J4j
XPM: AJHjbkVzHhHugd5bpKDtddVDfhtEB8jQZ4
primeminer [-options]
Primecoin 0.1.2 BETA
====================
* `-pooluser=[user]` Pool worker user name
* `-poolpassword=[pass]` Pool worker password
* `-poolip=[host]` Pool mining ip or host address
* `-poolport=[port]` Pool mining port
* `-poolshare=[chainlenght]` Minimum chain lenght of submitted shares, default 7
* `-genproclimit=[threads]` Number of CPU-Threads to use (1-32)
* `-minerid=[0-65000]` A free-to-choose worker ID
* `-poolfee=[1 - 100]` Set pool fee ín percent, if supported by pool
Copyright (c) 2013 Primecoin Developers
Distributed under conditional MIT/X11 software license, see the accompanying
file COPYING.
This product includes software developed by the OpenSSL Project for use in the [OpenSSL Toolkit](http://www.openssl.org/). This product includes
cryptographic software written by Eric Young ([eay@cryptsoft.com](mailto:eay@cryptsoft.com)), and UPnP software written by Thomas Bernard.
Intro
---------------------
Primecoin is a free open source cryptocurrency that implements the first
scientific computing proof-of-work for cryptocurrencies. The unique
proof-of-work design searches for rare prime formations, providing
experimental value for mathematicians to further understand the nature and
distribution related to prime number, a simple yet mysterious construct of
arithmetic that continues to baffle the top minds of mankind.
Upgrade
--------------------
First backup wallet. Then follow setup instructions. Double check balance
after completing setup and starting up client.
Setup
--------------------
You need the Qt4 run-time libraries to run Primecoin-Qt. On Debian or Ubuntu:
`sudo apt-get install libqtgui4`
Unpack the files into a directory and run:
- bin/32/primecoin-qt (GUI, 32-bit)
- bin/32/primecoind (headless, 32-bit)
- bin/64/primecoin-qt (GUI, 64-bit)
- bin/64/primecoind (headless, 64-bit)
Website: http://primecoin.org
Forum: http://ppcointalk.org
Github (source code + sig + wiki): https://github.com/primecoin/primecoin
Sourceforge (release builds): https://sourceforge.net/projects/primecoin
Bitcoin 0.8.3 BETA
====================
Copyright (c) 2009-2013 Bitcoin Developers
Distributed under the MIT/X11 software license, see the accompanying
file COPYING or http://www.opensource.org/licenses/mit-license.php.
This product includes software developed by the OpenSSL Project for use in the [OpenSSL Toolkit](http://www.openssl.org/). This product includes
cryptographic software written by Eric Young ([eay@cryptsoft.com](mailto:eay@cryptsoft.com)), and UPnP software written by Thomas Bernard.
Intro
---------------------
Bitcoin is a free open source peer-to-peer electronic cash system that is
completely decentralized, without the need for a central server or trusted
parties. Users hold the crypto keys to their own money and transact directly
with each other, with the help of a P2P network to check for double-spending.
Setup
---------------------
You need the Qt4 run-time libraries to run Bitcoin-Qt. On Debian or Ubuntu:
`sudo apt-get install libqtgui4`
Unpack the files into a directory and run:
- bin/32/bitcoin-qt (GUI, 32-bit)
- bin/32/bitcoind (headless, 32-bit)
- bin/64/bitcoin-qt (GUI, 64-bit)
- bin/64/bitcoind (headless, 64-bit)
See the documentation at the [Bitcoin Wiki](https://en.bitcoin.it/wiki/Main_Page)
for help and more information.
Other Pages
---------------------
Documentation overview
----------------------
- [Unix Build Notes](build-unix.md)
- [OSX Build Notes](build-osx.md)
- [Windows Build Notes](build-msw.md)
- [Coding Guidelines](coding.md)
- [Release Process](release-process.md)
- [Release Notes](release-notes.md)
- [Multiwallet Qt Development](multiwallet-qt.md)
- [Unit Tests](unit-tests.md)
- [Translation Process](translation_process.md)

View file

@ -1,88 +0,0 @@
Primecoin High Performance Version
==================================
This is the high performance version of Sunny King's Primecoin tree.
Features:
* Use GMP for bignum calculations in the mining threads
* Replaced some bignum calculations with 64-bit arithmetic inside the sieve
* Reduced the amount of memory allocations
* L1 and L2 cache optimizations
* Process only 10% of base primes when weaving the sieve
* Configurable sieve size
Donations are welcome if you want to support my work.
BTC: 1EaHwHBWeoJtSM2jEdx9Su1NcKvdXbsqxX
LTC: LPD1zDChmqcqKGHFHuLX2JWMMEC5jD5J4j
XPM: AJHjbkVzHhHugd5bpKDtddVDfhtEB8jQZ4
Primecoin 0.1.2 BETA
====================
Copyright (c) 2013 Primecoin Developers
Distributed under conditional MIT/X11 software license, see the accompanying
file COPYING.
This product includes software developed by the OpenSSL Project for use in
the OpenSSL Toolkit (http://www.openssl.org/). This product includes
cryptographic software written by Eric Young (eay@cryptsoft.com).
Intro
---------------------
Primecoin is a free open source cryptocurrency that implements the first
scientific computing proof-of-work for cryptocurrencies. The unique
proof-of-work design searches for rare prime formations, providing
experimental value for mathematicians to further understand the nature and
distribution related to prime number, a simple yet mysterious construct of
arithmetic that continues to baffle the top minds of mankind.
Upgrade
--------------------
First backup wallet. Uninstall previous version and then follow setup
instructions. Double check balance after completing setup and starting up
client.
Setup
-----
Complete windows setup procedure and run Primecoin (Qt).
Website: http://primecoin.org
Forum: http://ppcointalk.org
Github (source code + sig + wiki): https://github.com/primecoin/primecoin
Sourceforge (release builds): https://sourceforge.net/projects/primecoin
Bitcoin 0.8.3 BETA
==================
Copyright (c) 2009-2013 Bitcoin Developers
Distributed under the MIT/X11 software license, see the accompanying
file COPYING or http://www.opensource.org/licenses/mit-license.php.
This product includes software developed by the OpenSSL Project for use in
the OpenSSL Toolkit (http://www.openssl.org/). This product includes
cryptographic software written by Eric Young (eay@cryptsoft.com).
Intro
-----
Bitcoin is a free open source peer-to-peer electronic cash system that is
completely decentralized, without the need for a central server or trusted
parties. Users hold the crypto keys to their own money and transact directly
with each other, with the help of a P2P network to check for double-spending.
Setup
-----
Unpack the files into a directory and run bitcoin-qt.exe.
Bitcoin-Qt is the original Bitcoin client and it builds the backbone of the network.
However, it downloads and stores the entire history of Bitcoin transactions;
depending on the speed of your computer and network connection, the synchronization
process can take anywhere from a few hours to a day or more.
See the bitcoin wiki at:
https://en.bitcoin.it/wiki/Main_Page
for more help and information.

View file

@ -2,13 +2,13 @@ Copyright (c) 2009-2013 Bitcoin Developers
Distributed under the MIT/X11 software license, see the accompanying
file COPYING or http://www.opensource.org/licenses/mit-license.php.
This product includes software developed by the OpenSSL Project for use in the [OpenSSL Toolkit](http://www.openssl.org/). This product includes
cryptographic software written by Eric Young ([eay@cryptsoft.com](mailto:eay@cryptsoft.com)), and UPnP software written by Thomas Bernard.
This product includes software developed by the OpenSSL Project for
use in the [OpenSSL Toolkit](http://www.openssl.org/). This product
includes cryptographic software written by Eric Young
([eay@cryptsoft.com](mailto:eay@cryptsoft.com)), and UPnP software
written by Thomas Bernard.
See readme-qt.rst for instructions on building Bitcoin-Qt, the
graphical user interface.
WINDOWS BUILD NOTES
===================

View file

@ -48,7 +48,7 @@ Dependency Build Instructions: Ubuntu & Debian
----------------------------------------------
Build requirements:
sudo apt-get install build-essential libssl-dev libboost-all-dev libgmp-dev
sudo apt-get install build-essential libssl-dev libgmp-dev
Berkeley db4.8 packages are available [here](https://launchpad.net/~bitcoin/+archive/bitcoin):
@ -59,12 +59,16 @@ Berkeley db4.8 packages are available [here](https://launchpad.net/~bitcoin/+arc
Ubuntu precise has packages for libdb5.1-dev and libdb5.1++-dev,
but using these will break binary wallet compatibility, and is not recommended.
If you have trouble with libboost dependencies, make sure these are installed:
Prior Boost <1.48 install `libboost-all-dev`
sudo apt-get install libboost-all-dev
If you have trouble with Boost >= 1.48 dependencies, make sure these are installed as the `libboost-all` package does not include all needed dependencies:
sudo apt-get install libboost-chrono1.48-dev libboost-filesystem1.48-dev libboost-system1.48-dev libboost-program-options1.48-dev libboost-thread1.48-dev
(If using Boost 1.37, append -mt to the boost libraries in the makefile,
use `apt-cache search libboost` to find out which version is available for your system.)
If you are using Boost 1.37, append -mt to the boost libraries in the makefile,
use `apt-cache search libboost` to find out which version is available for your system.
Optional: