2014-01-10 16:28:47 +01:00
|
|
|
Xcoin integration/staging tree
|
2012-12-13 03:27:58 +01:00
|
|
|
================================
|
|
|
|
|
|
2014-01-10 16:28:47 +01:00
|
|
|
http://www.xcoin.org
|
2012-12-13 03:27:58 +01:00
|
|
|
|
2013-03-22 05:49:17 +01:00
|
|
|
Copyright (c) 2009-2013 Bitcoin Developers
|
2014-01-10 16:28:47 +01:00
|
|
|
Copyright (c) 2011-2013 Xcoin Developers
|
2012-12-13 03:27:58 +01:00
|
|
|
|
2014-01-10 16:28:47 +01:00
|
|
|
What is Xcoin?
|
2012-12-13 03:27:58 +01:00
|
|
|
----------------
|
|
|
|
|
|
2014-01-10 16:28:47 +01:00
|
|
|
Xcoin is a lite version of Bitcoin using scrypt as a proof-of-work algorithm.
|
2013-05-18 11:40:53 +02:00
|
|
|
- 2.5 minute block targets
|
|
|
|
|
- subsidy halves in 840k blocks (~4 years)
|
|
|
|
|
- ~84 million total coins
|
|
|
|
|
|
|
|
|
|
The rest is the same as Bitcoin.
|
|
|
|
|
- 50 coins per block
|
|
|
|
|
- 2016 blocks to retarget difficulty
|
2012-12-13 03:27:58 +01:00
|
|
|
|
|
|
|
|
For more information, as well as an immediately useable, binary version of
|
2014-01-10 16:28:47 +01:00
|
|
|
the Xcoin client sofware, see http://www.xcoin.org.
|
2012-12-13 03:27:58 +01:00
|
|
|
|
|
|
|
|
License
|
|
|
|
|
-------
|
|
|
|
|
|
2014-01-10 16:28:47 +01:00
|
|
|
Xcoin is released under the terms of the MIT license. See `COPYING` for more
|
2012-12-13 03:27:58 +01:00
|
|
|
information or see http://opensource.org/licenses/MIT.
|
2010-09-23 20:06:50 +02:00
|
|
|
|
2011-01-21 16:52:48 +01:00
|
|
|
Development process
|
2012-12-13 03:27:58 +01:00
|
|
|
-------------------
|
2010-09-23 20:06:50 +02:00
|
|
|
|
2012-12-13 03:27:58 +01:00
|
|
|
Developers work in their own trees, then submit pull requests when they think
|
|
|
|
|
their feature or bug fix is ready.
|
2011-09-06 05:02:35 +02:00
|
|
|
|
2014-01-10 16:28:47 +01:00
|
|
|
If it is a simple/trivial/non-controversial change, then one of the Xcoin
|
2012-12-13 03:27:58 +01:00
|
|
|
development team members simply pulls it.
|
2011-09-06 05:02:35 +02:00
|
|
|
|
2012-12-13 03:27:58 +01: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
|
|
|
|
|
[mailing list](http://sourceforge.net/mailarchive/forum.php?forum_name=bitcoin-development).
|
2010-12-19 16:39:36 +01:00
|
|
|
|
2012-12-13 03:27:58 +01: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 16:39:36 +01:00
|
|
|
|
2012-12-13 03:27:58 +01:00
|
|
|
The `master` branch is regularly built and tested, but is not guaranteed to be
|
|
|
|
|
completely stable. [Tags](https://github.com/bitcoin/bitcoin/tags) are created
|
2014-01-10 16:28:47 +01:00
|
|
|
regularly to indicate new official, stable release versions of Xcoin.
|
2010-12-19 16:39:36 +01:00
|
|
|
|
2013-01-09 21:55:47 +01:00
|
|
|
Testing
|
2012-12-13 03:27:58 +01: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 04:22:19 +02:00
|
|
|
|
2012-12-13 03:27:58 +01:00
|
|
|
Developers are strongly encouraged to write unit tests for new code, and to
|
|
|
|
|
submit new unit tests for old code.
|
2011-09-27 04:22:19 +02:00
|
|
|
|
2012-12-13 03:27:58 +01:00
|
|
|
Unit tests for the core code are in `src/test/`. To compile and run them:
|
2011-09-27 04:22:19 +02:00
|
|
|
|
2013-02-24 22:22:38 +01:00
|
|
|
cd src; make -f makefile.unix test
|
2013-01-09 21:55:47 +01:00
|
|
|
|
2012-12-13 03:27:58 +01:00
|
|
|
Unit tests for the GUI code are in `src/qt/test/`. To compile and run them:
|
2013-01-09 21:55:47 +01:00
|
|
|
|
2012-12-13 03:27:58 +01:00
|
|
|
qmake BITCOIN_QT_TEST=1 -o Makefile.test bitcoin-qt.pro
|
|
|
|
|
make -f Makefile.test
|
2014-01-10 16:28:47 +01:00
|
|
|
./xcoin-qt_test
|
2013-01-09 21:55:47 +01:00
|
|
|
|
