Add the command to install the parity-bitcoin snap
Putting the installation instructions for the snap will help getting more testers, and then to publish it in the stable channel with more confidence.
This commit is contained in:
parent
eaee51a7a3
commit
ed7bec40df
16
README.md
16
README.md
|
@ -5,7 +5,9 @@ The Parity Bitcoin client
|
||||||
|
|
||||||
Gitter [![Gitter https://gitter.im/paritytech/parity-bitcoin](https://badges.gitter.im/paritytech/parity-bitcoin.svg)](https://gitter.im/paritytech/parity-bitcoin)
|
Gitter [![Gitter https://gitter.im/paritytech/parity-bitcoin](https://badges.gitter.im/paritytech/parity-bitcoin.svg)](https://gitter.im/paritytech/parity-bitcoin)
|
||||||
|
|
||||||
- [Install guide](#install-guide)
|
- [Installing from source](#installing-from-source)
|
||||||
|
|
||||||
|
- [Installing the snap](#installing-the-snap)
|
||||||
|
|
||||||
- [Running tests](#running-tests)
|
- [Running tests](#running-tests)
|
||||||
|
|
||||||
|
@ -28,9 +30,9 @@ Gitter [![Gitter https://gitter.im/paritytech/parity-bitcoin](https://badges.git
|
||||||
[travis-url]: https://travis-ci.com/paritytech/parity-bitcoin
|
[travis-url]: https://travis-ci.com/paritytech/parity-bitcoin
|
||||||
[doc-url]: https://paritytech.github.io/parity-bitcoin/pbtc/index.html
|
[doc-url]: https://paritytech.github.io/parity-bitcoin/pbtc/index.html
|
||||||
|
|
||||||
## Install guide
|
## Installing from source
|
||||||
|
|
||||||
As for now `pbtc` can be installed only from source. It requires `rustc` and `cargo`.
|
Installing `pbtc` from source requires `rustc` and `cargo`.
|
||||||
|
|
||||||
Minimal supported version is `rustc 1.16.0 (30cf806ef 2017-03-10)`
|
Minimal supported version is `rustc 1.16.0 (30cf806ef 2017-03-10)`
|
||||||
|
|
||||||
|
@ -78,6 +80,14 @@ cargo build -p pbtc --release
|
||||||
|
|
||||||
`pbtc` is now available at either `./target/debug/pbtc` or `./target/release/pbtc`
|
`pbtc` is now available at either `./target/debug/pbtc` or `./target/release/pbtc`
|
||||||
|
|
||||||
|
## Installing the snap
|
||||||
|
|
||||||
|
In any of the [supported Linux distros](https://snapcraft.io/docs/core/install):
|
||||||
|
|
||||||
|
```
|
||||||
|
sudo snap install parity-bitcoin --edge
|
||||||
|
```
|
||||||
|
|
||||||
## Running tests
|
## Running tests
|
||||||
|
|
||||||
`pbtc` has internal unit tests and it conforms to external integration tests
|
`pbtc` has internal unit tests and it conforms to external integration tests
|
||||||
|
|
Loading…
Reference in New Issue