Update README.md
This commit is contained in:
vertoe
parent
c1aae9e3bd
commit
8447120e86
90
README.md
90
README.md
@ -1,86 +1,50 @@
|
||||
Bitcoin Core integration/staging tree
|
||||
=====================================
|
||||
Darkcoin Core integration/staging tree 0.11
|
||||
===========================================
|
||||
|
||||
http://www.bitcoin.org
|
||||
http://www.darkcoin.io
|
||||
|
||||
Copyright (c) 2009-2014 Bitcoin Core Developers
|
||||
Copyright (c) 2014 Darkcoin Core Developers
|
||||
|
||||
What is Bitcoin?
|
||||
|
||||
What is Darkcoin?
|
||||
----------------
|
||||
|
||||
Bitcoin is an experimental new digital currency that enables instant payments to
|
||||
anyone, anywhere in the world. Bitcoin uses peer-to-peer technology to operate
|
||||
with no central authority: managing transactions and issuing money are carried
|
||||
out collectively by the network. Bitcoin Core is the name of open source
|
||||
software which enables the use of this currency.
|
||||
Darkcoin is an experimental new digital currency that enables anonymous, instant
|
||||
payments to anyone, anywhere in the world. Darkcoin uses peer-to-peer technology
|
||||
to operate with no central authority: managing transactions and issuing money
|
||||
are carried out collectively by the network. Darkcoin Core is the name of open
|
||||
source software which enables the use of this currency.
|
||||
|
||||
For more information, as well as an immediately useable, binary version of
|
||||
the Bitcoin Core software, see http://www.bitcoin.org/en/download.
|
||||
the Darkcoin Core software, see http://www.darkcoin.io/downloads.
|
||||
|
||||
|
||||
License
|
||||
-------
|
||||
|
||||
Bitcoin Core is released under the terms of the MIT license. See [COPYING](COPYING) for more
|
||||
Darkcoin Core is released under the terms of the MIT license. See [COPYING](COPYING) for more
|
||||
information or see http://opensource.org/licenses/MIT.
|
||||
|
||||
Development process
|
||||
-------------------
|
||||
|
||||
Developers work in their own trees, then submit pull requests when they think
|
||||
their feature or bug fix is ready.
|
||||
Building process
|
||||
-----------------
|
||||
|
||||
If it is a simple/trivial/non-controversial change, then one of the Bitcoin
|
||||
development team members simply pulls it.
|
||||
**compiling Darkcoin from git**
|
||||
|
||||
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).
|
||||
Use the autogen script to prepare the build environment.
|
||||
|
||||
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.md](doc/coding.md)) or are
|
||||
controversial.
|
||||
./autogen.sh
|
||||
./configure
|
||||
make
|
||||
|
||||
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
|
||||
regularly to indicate new official, stable release versions of Bitcoin.
|
||||
**precompiled binaries**
|
||||
|
||||
Testing
|
||||
-------
|
||||
Precompiled binaries are available at github, see
|
||||
https://github.com/darkcoinproject/darkcoin-binaries
|
||||
|
||||
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.
|
||||
Always verify the signatures and checksums.
|
||||
|
||||
### Automated Testing
|
||||
|
||||
Developers are strongly encouraged to write unit tests for new code, and to
|
||||
submit new unit tests for old code. Unit tests can be compiled and run (assuming they weren't disabled in configure) with: `make check`
|
||||
|
||||
Every pull request is built for both Windows and Linux on a dedicated server,
|
||||
and unit and sanity tests are automatically run. The binaries produced may be
|
||||
used for manual QA testing — a link to them will appear in a comment on the
|
||||
pull request posted by [BitcoinPullTester](https://github.com/BitcoinPullTester). See https://github.com/TheBlueMatt/test-scripts
|
||||
for the build/test scripts.
|
||||
|
||||
### Manual Quality Assurance (QA) Testing
|
||||
|
||||
Large changes should have a test plan, and should be tested by somebody other
|
||||
than the developer who wrote the code.
|
||||
See https://github.com/bitcoin/QA/ for how to create a test plan.
|
||||
|
||||
Translations
|
||||
------------
|
||||
|
||||
Changes to translations as well as new translations can be submitted to
|
||||
[Bitcoin Core's Transifex page](https://www.transifex.com/projects/p/bitcoin/).
|
||||
|
||||
Periodically the translations are pulled from Transifex and merged into the git repository. See the
|
||||
[translation process](doc/translation_process.md) for details on how this works.
|
||||
|
||||
**Important**: We do not accept translation changes as github pull request because the next
|
||||
pull from Transifex would automatically overwrite them again.
|
||||
|
||||
Development tips and tricks
|
||||
---------------------------
|
||||
@ -103,7 +67,7 @@ to see it.
|
||||
|
||||
**testnet and regtest modes**
|
||||
|
||||
Run with the -testnet option to run with "play bitcoins" on the test network, if you
|
||||
Run with the -testnet option to run with "play darkcoins" on the test network, if you
|
||||
are testing multi-machine code that needs to operate across the internet.
|
||||
|
||||
If you are testing something that can run on one machine, run with the -regtest option.
|
||||
@ -112,7 +76,7 @@ that run in -regest mode.
|
||||
|
||||
**DEBUG_LOCKORDER**
|
||||
|
||||
Bitcoin Core is a multithreaded application, and deadlocks or other multithreading bugs
|
||||
Darkcoin Core is a multithreaded application, and deadlocks or other multithreading bugs
|
||||
can be very difficult to track down. Compiling with -DDEBUG_LOCKORDER (configure
|
||||
CXXFLAGS="-DDEBUG_LOCKORDER -g") inserts run-time checks to keep track of what locks
|
||||
are held, and adds warning to the debug.log file if inconsistencies are detected.
|
||||
|
||||
50
TODO.md
50
TODO.md
@ -1,50 +0,0 @@
|
||||
Porting Bitcoin 0.9.3 to Darkcoin
|
||||
=================================
|
||||
|
||||
Staging tree for Darkcoin-0.11.0.
|
||||
|
||||
|
||||
DONE:
|
||||
-----
|
||||
|
||||
- Strings in config, path and pid (~/.darkcoin)
|
||||
- Ports for communication and RPC (port=9999; rpcport=9998)
|
||||
- Version numbers, protocol version, wallet version (compatible with DRK network)
|
||||
- Added darkcoin seednodes
|
||||
- Updated address versions (Public keys, Multisig keys)
|
||||
- Changed genesisblockhash and timestamp
|
||||
- Reviewed and updated checkpoints
|
||||
- Adjusted algorithm (X11)
|
||||
- Updated subsidity function (Block value)
|
||||
- Adjusted wallet keypool size to 1000 and added loading indicator on fresh wallet load
|
||||
- Adjusted difficulty and blockvalue (KGW, DGW based on blockheight)
|
||||
- Defined regression test genesis block
|
||||
- Updated wallet layout and branding
|
||||
- Reset testnet (v4) with new genesis and address version (start with x)
|
||||
- BIP0032 addresses xpub and xpriv start with x (unchanged by design)
|
||||
- Changed Darkcoin units to DRK and added duffs
|
||||
- Fixed internal walletminer
|
||||
|
||||
|
||||
MANDATORY:
|
||||
----------
|
||||
|
||||
- Check rpcminer (should be working though)
|
||||
|
||||
|
||||
BUGS:
|
||||
-----
|
||||
|
||||
- Daemon and CLI tool can't connect to testnet/regtest instances (wrong port?)
|
||||
- Daemon and CLI tool can't authenticate via RPC (uh-oh?)
|
||||
- Qt wallet can't find the config file in testnet mode (wrong path?)
|
||||
|
||||
|
||||
ADDITIONAL:
|
||||
-----------
|
||||
|
||||
- Include trusted public key for message signing
|
||||
- Masternodes, Enforcement, Darksend, InstantX, Atomic Transfers, ...
|
||||
- Remove Bitcoin dead weight (SHA256, hardcoded keys, seednodes, ...)
|
||||
- Update strings
|
||||
- Write tests
|
||||
Loading…
Reference in New Issue
Block a user