2013-09-03 08:33:19 +00:00
|
|
|
Primecoin High Performance Version (Pool Edition)
|
|
|
|
|
================================================
|
2013-07-13 21:42:11 +00:00
|
|
|
|
2013-09-03 07:17:40 +00:00
|
|
|
This is a pool mining version
|
2013-09-03 08:33:19 +00:00
|
|
|
based on mikaelh's high performance version of Sunny King's Primecoin tree.
|
|
|
|
|
|
|
|
|
|
Features:
|
|
|
|
|
- pool mining client
|
|
|
|
|
- getwork-protocol (with longpoll-support)
|
|
|
|
|
- code integration into original client
|
2013-09-03 07:17:40 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2013-07-13 21:42:11 +00:00
|
|
|
|
2013-09-03 08:33:19 +00:00
|
|
|
See forked project for more information.
|
2013-07-13 21:42:11 +00:00
|
|
|
|
2013-07-26 04:58:38 +00:00
|
|
|
Primecoin integration/staging tree
|
|
|
|
|
==================================
|
2012-12-13 02:27:58 +00:00
|
|
|
|
2013-07-26 04:58:38 +00:00
|
|
|
http://primecoin.org
|
2012-12-13 02:27:58 +00:00
|
|
|
|
2013-07-26 04:58:38 +00:00
|
|
|
Copyright (c) 2013 Primecoin Developers
|
2013-07-26 14:46:33 +00:00
|
|
|
|
2013-03-22 04:49:17 +00:00
|
|
|
Copyright (c) 2009-2013 Bitcoin Developers
|
2013-07-26 14:46:33 +00:00
|
|
|
|
2013-07-26 04:58:38 +00:00
|
|
|
Copyright (c) 2011-2013 PPCoin Developers
|
2012-12-13 02:27:58 +00:00
|
|
|
|
2013-07-26 04:58:38 +00:00
|
|
|
What is Primecoin?
|
|
|
|
|
------------------
|
2012-12-13 02:27:58 +00:00
|
|
|
|
2013-07-26 04:58:38 +00:00
|
|
|
Primecoin is an experimental cryptocurrency that introduces the first
|
|
|
|
|
scientific computing proof-of-work to cryptocurrency technology. Primecoin's
|
|
|
|
|
proof-of-work is an innovative design based on searching for prime number
|
|
|
|
|
chains, providing potential scientific value in addition to minting and
|
|
|
|
|
security for the network. Similar to Bitcoin, Primecoin enables instant payments
|
|
|
|
|
to anyone, anywhere in the world. It also uses peer-to-peer technology to
|
|
|
|
|
operate with no central authority: managing transactions and issuing money are
|
|
|
|
|
carried out collectively by the network. Primecoin is also the name of the open
|
|
|
|
|
source software which enables the use of this currency.
|
2012-12-13 02:27:58 +00:00
|
|
|
|
|
|
|
|
For more information, as well as an immediately useable, binary version of
|
2013-07-26 04:58:38 +00:00
|
|
|
the Primecoin client sofware, see http://primecoin.org.
|
2012-12-13 02:27:58 +00:00
|
|
|
|
|
|
|
|
License
|
|
|
|
|
-------
|
|
|
|
|
|
2013-07-26 04:58:38 +00:00
|
|
|
Primecoin is released under conditional MIT license. See COPYING` for more
|
|
|
|
|
information.
|
2010-09-23 18:06:50 +00:00
|
|
|
|
2011-01-21 15:52:48 +00:00
|
|
|
Development process
|
2012-12-13 02:27:58 +00:00
|
|
|
-------------------
|
2010-09-23 18:06:50 +00:00
|
|
|
|
2012-12-13 02:27:58 +00:00
|
|
|
Developers work in their own trees, then submit pull requests when they think
|
|
|
|
|
their feature or bug fix is ready.
|
2011-09-06 03:02:35 +00:00
|
|
|
|
2012-12-13 02:27:58 +00:00
|
|
|
If it is a simple/trivial/non-controversial change, then one of the Bitcoin
|
|
|
|
|
development team members simply pulls it.
|
2011-09-06 03:02:35 +00:00
|
|
|
|
2012-12-13 02:27:58 +00:00
|
|
|
If it is a *more complicated or potentially controversial* change, then the patch
|
|
|
|
|
submitter will be asked to start a discussion (if they haven't already) on the
|
2013-07-26 04:58:38 +00:00
|
|
|
ppcoin/primecoin forum (http://ppcointalk.org).
|
2010-12-19 15:39:36 +00:00
|
|
|
|
2012-12-13 02:27:58 +00:00
|
|
|
The patch will be accepted if there is broad consensus that it is a good thing.
|
|
|
|
|
Developers should expect to rework and resubmit patches if the code doesn't
|
|
|
|
|
match the project's coding conventions (see `doc/coding.txt`) or are
|
|
|
|
|
controversial.
|
2010-12-19 15:39:36 +00:00
|
|
|
|
2012-12-13 02:27:58 +00:00
|
|
|
The `master` branch is regularly built and tested, but is not guaranteed to be
|
2013-07-26 04:58:38 +00:00
|
|
|
completely stable. [Tags](https://github.com/primecoin/primecoin/tags) are
|
|
|
|
|
created regularly to indicate new official, stable release versions of
|
|
|
|
|
Primecoin.
|
2010-12-19 15:39:36 +00:00
|
|
|
|
2013-01-09 20:55:47 +00:00
|
|
|
Testing
|
2012-12-13 02:27:58 +00:00
|
|
|
-------
|
|
|
|
|
|
|
|
|
|
Testing and code review is the bottleneck for development; we get more pull
|
|
|
|
|
requests than we can review and test. Please be patient and help out, and
|
|
|
|
|
remember this is a security-critical project where any mistake might cost people
|
|
|
|
|
lots of money.
|
|
|
|
|
|
|
|
|
|
### Automated Testing
|
2011-09-27 02:22:19 +00:00
|
|
|
|
2012-12-13 02:27:58 +00:00
|
|
|
Developers are strongly encouraged to write unit tests for new code, and to
|
|
|
|
|
submit new unit tests for old code.
|
2011-09-27 02:22:19 +00:00
|
|
|
|
2012-12-13 02:27:58 +00:00
|
|
|
Unit tests for the core code are in `src/test/`. To compile and run them:
|
2011-09-27 02:22:19 +00:00
|
|
|
|
2013-02-24 21:22:38 +00:00
|
|
|
cd src; make -f makefile.unix test
|
2013-01-09 20:55:47 +00:00
|
|
|
|
2012-12-13 02:27:58 +00:00
|
|
|
Unit tests for the GUI code are in `src/qt/test/`. To compile and run them:
|
2013-01-09 20:55:47 +00:00
|
|
|
|
2012-12-13 02:27:58 +00:00
|
|
|
qmake BITCOIN_QT_TEST=1 -o Makefile.test bitcoin-qt.pro
|
|
|
|
|
make -f Makefile.test
|
2013-02-22 16:41:23 +00:00
|
|
|
./bitcoin-qt_test
|
2013-01-09 20:55:47 +00:00
|
|
|
|
2012-12-13 02:27:58 +00:00
|
|
|
### Manual Quality Assurance (QA) Testing
|
2013-01-09 20:55:47 +00:00
|
|
|
|
2012-12-13 02:27:58 +00:00
|
|
|
Large changes should have a test plan, and should be tested by somebody other
|
|
|
|
|
than the developer who wrote the code.
|
2013-01-09 20:55:47 +00:00
|
|
|
|
2013-05-05 20:32:35 +00:00
|
|
|
See https://github.com/bitcoin/QA/ for how to create a test plan.
|
