dash/README.md

75 lines
2.7 KiB
Markdown
Raw Normal View History

2014-01-29 02:24:52 +01:00
DarkCoin integration/staging tree
================================
2014-01-29 02:24:52 +01:00
http://www.darkcoin.io
2013-03-22 05:49:17 +01:00
Copyright (c) 2009-2013 Bitcoin Developers
2014-01-29 05:31:46 +01:00
Copyright (c) 2013-2014 DarkCoin Developers
2014-01-29 02:24:52 +01:00
What is DarkCoin?
----------------
2014-01-29 05:31:46 +01:00
DarkCoin is a lite version of Bitcoin using X11 as a proof-of-work algorithm.
- Super secure hashing algorithm: 11 rounds of scientific hashing functions (blake, bmw, groestl, jh, keccak, skein, luffa, cubehash, shavite, simd, echo)
- Block reward is controlled by moore's law: 2222222/(((Difficulty+2600)/9)^2)
- GPU/CPU only mining
2014-01-29 05:31:46 +01:00
- Block generation: 2.5 minutes
- Difficulty Retargets every block using Dark Gravity Wave
- Est. ~7M Coins in 2015, ~13M in 2020, ~23M in 2030
- Anonymous blockchain using DarkSend technology (Based on CoinJoin): Beta Testing
For more information, as well as an immediately useable, binary version of
2014-01-29 02:24:52 +01:00
the DarkCoin client sofware, see http://www.darkcoin.io.
License
-------
2014-01-29 02:24:52 +01:00
DarkCoin is released under the terms of the MIT license. See `COPYING` for more
information or see http://opensource.org/licenses/MIT.
2010-09-23 20:06:50 +02:00
Development process
-------------------
2010-09-23 20:06:50 +02: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-29 02:24:52 +01:00
If it is a simple/trivial/non-controversial change, then one of the DarkCoin
development team members simply pulls it.
2011-09-06 05:02:35 +02: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
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
The `master` branch is regularly built and tested, but is not guaranteed to be
completely stable. [Tags](https://github.com/darkcoinproject/darkcoin/tags) are created
2014-01-29 02:24:52 +01:00
regularly to indicate new official, stable release versions of DarkCoin.
2010-12-19 16:39:36 +01:00
Testing
-------
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
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
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
Unit tests for the GUI code are in `src/qt/test/`. To compile and run them:
qmake BITCOIN_QT_TEST=1 -o Makefile.test bitcoin-qt.pro
make -f Makefile.test
2014-01-29 02:24:52 +01:00
./darkcoin-qt_test