2016-01-30 14:30:13 -05:00
LBRYcrd integration/staging tree
2013-12-17 11:50:26 +01:00
=====================================
2012-12-12 21:27:58 -05:00
2016-01-30 14:30:13 -05:00
http://lbry.io
2014-08-26 21:10:52 +12:00
2016-01-30 14:30:13 -05:00
What is LBRYcrd?
----------------
LBRYcrd is a fork of bitcoin core designed for use in the LBRY network.
LBRYcrd uses a blockchain similar to bitcoin's to implement a unique naming system in which the person who dedicates the largest amount of LBC to a name has control over that name.
2012-12-12 21:27:58 -05:00
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
2013-12-17 08:47:30 +01:00
out collectively by the network. Bitcoin Core is the name of open source
2012-12-12 21:27:58 -05:00
software which enables the use of this currency.
For more information, as well as an immediately useable, binary version of
2014-07-01 00:05:24 -05:00
the Bitcoin Core software, see https://www.bitcoin.org/en/download.
2012-12-12 21:27:58 -05:00
License
-------
2013-12-17 08:47:30 +01:00
Bitcoin Core is released under the terms of the MIT license. See [COPYING ](COPYING ) for more
2012-12-12 21:27:58 -05:00
information or see http://opensource.org/licenses/MIT.
2010-09-23 18:06:50 +00:00
2015-09-24 14:28:07 +01:00
Development Process
2012-12-12 21:27:58 -05:00
-------------------
2010-09-23 18:06:50 +00:00
2012-12-12 21:27:58 -05:00
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
2015-10-05 21:20:43 +02:00
regularly to indicate new official, stable release versions of Bitcoin Core.
2010-12-19 10:39:36 -05:00
2015-09-24 14:28:07 +01:00
The contribution workflow is described in [CONTRIBUTING.md ](CONTRIBUTING.md ).
The developer [mailing list ](https://lists.linuxfoundation.org/mailman/listinfo/bitcoin-dev )
should be used to discuss complicated or controversial changes before working
on a patch set.
2015-09-30 14:37:40 +02:00
Developer IRC can be found on Freenode at #bitcoin -core-dev.
2015-09-24 14:28:07 +01:00
2013-01-09 15:55:47 -05:00
Testing
2012-12-12 21:27:58 -05:00
-------
Testing and code review is the bottleneck for development; we get more pull
2014-05-23 09:49:01 +02:00
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
2012-12-12 21:27:58 -05:00
lots of money.
### Automated Testing
2011-09-26 22:22:19 -04:00
2012-12-12 21:27:58 -05:00
Developers are strongly encouraged to write unit tests for new code, and to
2013-10-12 10:45:25 -04:00
submit new unit tests for old code. Unit tests can be compiled and run (assuming they weren't disabled in configure) with: `make check`
2013-01-09 15:55:47 -05:00
2015-06-30 09:40:44 -04:00
There are also regression and integration tests of the RPC interface, written
in Python, that are run automatically on the build server.
2015-10-03 08:03:25 -07:00
These tests can be run with: `qa/pull-tester/rpc-tests.py`
2015-06-30 09:40:44 -04:00
2012-12-12 21:27:58 -05:00
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
2013-05-05 23:32:35 +03:00
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
2012-12-12 21:27:58 -05:00
for the build/test scripts.
2013-01-09 15:55:47 -05:00
2012-12-12 21:27:58 -05:00
### Manual Quality Assurance (QA) Testing
2013-01-09 15:55:47 -05:00
2012-12-12 21:27:58 -05:00
Large changes should have a test plan, and should be tested by somebody other
than the developer who wrote the code.
2013-05-05 23:32:35 +03:00
See https://github.com/bitcoin/QA/ for how to create a test plan.
2014-04-09 20:11:08 +02:00
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/ ).
2014-07-07 16:32:38 +08:00
Translations are periodically pulled from Transifex and merged into the git repository. See the
2014-04-09 20:11:08 +02:00
[translation process ](doc/translation_process.md ) for details on how this works.
2014-07-07 16:32:38 +08:00
**Important**: We do not accept translation changes as GitHub pull requests because the next
2014-04-09 20:11:08 +02:00
pull from Transifex would automatically overwrite them again.
2014-05-23 10:30:38 -04:00
2014-07-07 16:32:38 +08:00
Translators should also subscribe to the [mailing list ](https://groups.google.com/forum/#!forum/bitcoin-translators ).