57 lines
2 KiB
Markdown
57 lines
2 KiB
Markdown
# LBRYcrd - The LBRY blockchain
|
|
|
|
|
|
## What is LBRYcrd?
|
|
|
|
LBRYcrd uses a blockchain similar to bitcoin's to implement an index and payment system for content on the LBRY network. It is a fork of bitcoin core.
|
|
|
|
|
|
## Development Process
|
|
|
|
The `master` branch is regularly built and tested, but is not guaranteed to be
|
|
completely stable. [Releases](https://github.com/lbryio/lbrycrd/releases) are created
|
|
regularly to indicate new official, stable release versions.
|
|
|
|
|
|
## Building LBRYcrd
|
|
|
|
|
|
Run `./reproducible_build.sh -c -t`. This should build the binaries and put them into the `./src` directory.
|
|
|
|
|
|
If that errors, please report the issue and see `doc/build-*.md` for further instructions.
|
|
|
|
|
|
The contribution workflow is described in [CONTRIBUTING.md](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](/doc/unit-tests.md) 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](/qa) of the RPC interface, written
|
|
in Python, that are run automatically on the build server.
|
|
These tests can be run (if the [test dependencies](/qa) are installed) with: `qa/pull-tester/rpc-tests.py`
|
|
|
|
The Travis CI system makes sure that every pull request is built, 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.
|
|
|
|
|
|
## License
|
|
|
|
MIT
|