You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Charlie Lee e93ff718c5 Add instructions for multi-processor gitian builds 4 years ago
.github Mention reporting security issues responsibly 5 years ago
.tx qt: Set transifex slug to 0.14 4 years ago
build-aux/m4 Explicitly search for bdb5.3. 4 years ago
contrib p2p: Hardcoded seeds update pre-0.15 branch 4 years ago
depends Merge #10508: Run Qt wallet tests on travis 4 years ago
doc Add instructions for multi-processor gitian builds 4 years ago
share Slightly overhaul NSI pixmaps 4 years ago
src qt: Periodic translations update 4 years ago
test [wallet] Specify wallet name in wallet loading errors 4 years ago
.gitattributes Separate protocol versioning from clientversion 7 years ago
.gitignore Use shared config file for functional and util tests 4 years ago
.travis.yml Merge #10508: Run Qt wallet tests on travis 4 years ago
CONTRIBUTING.md [doc] Add blob about finding reviewers. 4 years ago
COPYING [Trivial] Update license year range to 2017 4 years ago
INSTALL.md Update INSTALL landing redirection notice for build instructions. 5 years ago
Makefile.am Filter subtrees and and benchmarks from coverage report 4 years ago
README.md Rename test/pull-tester/rpc-tests.py to test/functional/test_runner.py 4 years ago
autogen.sh Add MIT license to autogen.sh and share/genbuild.sh 5 years ago
configure.ac Protect SSE4 code behind a compile-time flag 4 years ago
libbitcoinconsensus.pc.in Unify package name to as few places as possible without major changes 5 years ago

README.md

Bitcoin Core integration/staging tree

Build Status

https://bitcoincore.org

What is Bitcoin?

Bitcoin is an experimental 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.

For more information, as well as an immediately useable, binary version of the Bitcoin Core software, see https://bitcoin.org/en/download, or read the original whitepaper.

License

Bitcoin Core is released under the terms of the MIT license. See COPYING for more information or see https://opensource.org/licenses/MIT.

Development Process

The master branch is regularly built and tested, but is not guaranteed to be completely stable. Tags are created regularly to indicate new official, stable release versions of Bitcoin Core.

The contribution workflow is described in CONTRIBUTING.md.

The developer mailing list should be used to discuss complicated or controversial changes before working on a patch set.

Developer IRC can be found on Freenode at #bitcoin-core-dev.

Testing

Testing and code review is the bottleneck for development; we get more pull requests than we can review and test on short notice. Please be patient and help out by testing other people’s pull requests, and remember this is a security-critical project where any mistake might cost people lots of money.

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. Further details on running and extending unit tests can be found in /src/test/README.md.

There are also regression and integration tests, written in Python, that are run automatically on the build server. These tests can be run (if the test dependencies are installed) with: test/functional/test_runner.py

The Travis CI system makes sure that every pull request is built for Windows, Linux, and OS X, and that unit/sanity tests are run automatically.

Manual Quality Assurance (QA) Testing

Changes should be tested by somebody other than the developer who wrote the code. This is especially important for large or high-risk changes. It is useful to add a test plan to the pull request description if testing the changes is not straightforward.

Translations

Changes to translations as well as new translations can be submitted to Bitcoin Core’s Transifex page.

Translations are periodically pulled from Transifex and merged into the git repository. See the translation process for details on how this works.

Important: We do not accept translation changes as GitHub pull requests because the next pull from Transifex would automatically overwrite them again.

Translators should also subscribe to the mailing list.