update README
This commit is contained in:
parent
4ff143387e
commit
4e1df4de23
2 changed files with 32 additions and 25 deletions
57
README.md
57
README.md
|
@ -1,57 +1,64 @@
|
|||
# LBRYcrd - The LBRY blockchain
|
||||
|
||||
|
||||
## What is LBRYcrd?
|
||||
![alt text](lbrycrdd_daemon_screenshot.png "lbrycrdd daemon screenshot")
|
||||
|
||||
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.
|
||||
|
||||
## Installation
|
||||
|
||||
## Development Process
|
||||
Latest binaries are available from https://github.com/lbryio/lbrycrd/releases. There is no installation procedure, the binaries run as is.
|
||||
|
||||
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.
|
||||
## Usage
|
||||
|
||||
The "lbrycrdd" executable will start a LBRYcrd node and connect you to the LBRYcrd network. Use "lbrycrd-cli" executable
|
||||
to interact with the lbrycrdd executable through the command line. Help pages for both executable are available through
|
||||
the "--help" flag.
|
||||
|
||||
## Building LBRYcrd
|
||||
### Example Usage
|
||||
|
||||
Run `./lbrycrdd -daemon` to start lbrycrdd in the background.
|
||||
|
||||
Run `./lbrycrd-cli getinfo` to check for some basic informations about your LBRYcrd node.
|
||||
|
||||
Run `./lbrycrd-cli help` to get a list of all commands that you can run. To get help on specific commands run `./lbrycrd-cli [command_name] help`
|
||||
|
||||
## Running from Source
|
||||
|
||||
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.
|
||||
|
||||
## Contributing
|
||||
|
||||
The contribution workflow is described in [CONTRIBUTING.md](CONTRIBUTING.md).
|
||||
Contributions to this project are welcome, encouraged, and compensated. For more details, see [lbry.io/faq/contributing](https://lbry.io/faq/contributing)
|
||||
|
||||
|
||||
## Testing
|
||||
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.
|
||||
|
||||
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
|
||||
This project is MIT licensed. For the full license, see [LICENSE](LICENSE).
|
||||
|
||||
## Security
|
||||
|
||||
We take security seriously. Please contact security@lbry.io regarding any security issues.
|
||||
Our PGP key is [here](https://keybase.io/lbry/key.asc) if you need it.
|
||||
|
||||
## Contact
|
||||
|
||||
The primary contact for this project is [@kaykurokawa](https://github.com/kaykurokawa) (kay@lbry.io)
|
||||
|
||||
|
||||
|
|
BIN
lbrycrdd_daemon_screenshot.png
Normal file
BIN
lbrycrdd_daemon_screenshot.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 49 KiB |
Loading…
Reference in a new issue