Bitcoin Core integration/staging tree
Go to file
Martin Erlandsson 5918204304 Removed explicit mention of storage requirement (squashed)
Similarly discussed and fixed in the following bitcoin.org issue: https://github.com/bitcoin-dot-org/bitcoin.org/pull/2716

Removed mention of storage requirement

Agreeing with @laanwj that this mention of the storage requirement could be removed, I did so and changed the wording accordingly.
Would be nice to be able to add a link to a canonical source that is always updated, for those who want a number.

Update doc/README.md

Co-Authored-By: merland <martin@megabit.se>

Update README.md

added a missing 'a'
2018-10-22 15:02:27 +02:00
.github doc: Add GitHub pr template 2018-09-23 08:31:11 -04:00
.travis build: Pin to specific versions of Python packages we install from PyPI in Travis 2018-10-16 13:48:16 +02:00
.tx tx: Update transifex slug 016x→017x 2018-08-02 13:42:15 +02:00
build_msvc Merge #14146: wallet: Remove trailing separators from -walletdir arg 2018-10-18 10:58:59 +02:00
build-aux/m4 Merge #13095: build: update ax_boost_chrono/unit_test_framework 2018-07-26 08:54:59 -04:00
contrib [gitian] use versioned unsigned tarballs instead of generically named ones 2018-09-25 22:07:33 -04:00
depends Merge #14385: depends: qt: avoid system harfbuzz and bz2 2018-10-08 05:27:28 -03:00
doc Removed explicit mention of storage requirement (squashed) 2018-10-22 15:02:27 +02:00
share Merge #14018: Bugfix: NSIS: Exclude Makefile* from docs 2018-08-22 15:28:52 +02:00
src Merge #14374: qt: Add "Blocksdir" to Debug window 2018-10-18 12:31:20 +02:00
test Add ignored word: mut 2018-10-16 13:34:10 +02:00
.appveyor.yml appveyor: trivial build cache modifications 2018-10-05 13:46:40 +08:00
.gitattributes
.gitignore
.travis.yml qa: Run more tests with wallet disabled 2018-09-25 18:08:08 -04:00
autogen.sh
configure.ac configure: Make it possible to build only one of bitcoin-cli or bitcoin-tx 2018-09-13 11:48:23 +00:00
CONTRIBUTING.md doc: add note to contributor docs about warranted PR's 2018-07-30 23:47:46 +09:00
COPYING
INSTALL.md
libbitcoinconsensus.pc.in
Makefile.am Merge #14253: Build: during 'make clean', remove some files that are currently missed. 2018-10-08 04:32:48 -03:00
README.md doc: Adjust bitcoincore.org links 2018-07-22 10:32:38 -04:00

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://bitcoincore.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.

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 macOS, 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.