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.
MarcoFalke fada0c422c [doc] Fix doxygen comments for members 4 years ago
.tx qt: translation update prior to opening 0.12 translations 5 years ago
build-aux/m4 [build-aux] Update Boost & check macros to latest serials 4 years ago
contrib Merge #7723: build: python 3 compatibility 4 years ago
depends [Depends] Latest config.guess & config.sub 4 years ago
doc [doc] Fix doxygen comments for members 4 years ago
qa Merge #7489: tests: Make proxy_test work on travis servers without IPv6 4 years ago
share build: python 3 compatibility 4 years ago
src [doc] Fix doxygen comments for members 4 years ago
.gitattributes Separate protocol versioning from clientversion 6 years ago
.gitignore Merge pull request #6813 5 years ago
.travis.yml [travis] Exit early when check-doc.py fails 4 years ago
CONTRIBUTING.md Note that reviewers should mention the commit hash of the commits they reviewed. 5 years ago
COPYING Update license year range to 2016 5 years ago
INSTALL Prettify some /Contrib READMEs 7 years ago
Makefile.am build: python 3 compatibility 4 years ago
README.md Check if zmq is installed in tests, update docs 4 years ago
autogen.sh autogen.sh: warn about needing autoconf if autoreconf is not found 5 years ago
configure.ac Merge #7477: Fix quoting of copyright holders in configure.ac. 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 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.

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

There are also regression and integration tests of the RPC interface, written in Python, that are run automatically on the build server. These tests can be run (if the test dependencies are installed) with: qa/pull-tester/rpc-tests.py

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

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.