readme+docs: Consolidate installation docs
This commit is contained in:
1 parent
06782ebdb3
commit
9f8378f4cf
2 files changed
+108
-100
No files matched your search
@@ -51,53 +51,9 @@ said, `lnd` the current status of `lnd`'s BOLT compliance is:
|
||||
- [X] BOLT 8: Encrypted and Authenticated Transport
|
||||
|
||||
## Installation
|
||||
In order to build from source, the following build dependencies are
|
||||
required:
|
||||
In order to build from source, please see [the installation
|
||||
instructions](docs/INSTALL.md).
|
||||
|
||||
* **Go:** Installation instructions can be found [here](http://golang.org/doc/install).
|
||||
|
||||
It is recommended to add `$GOPATH/bin` to your `PATH` at this point.
|
||||
**Note:** If you are building with `Go 1.5`, then you'll need to
|
||||
enable the vendor experiment by setting the `GO15VENDOREXPERIMENT`
|
||||
environment variable to `1`. If you're using `Go 1.6` or later, then
|
||||
it is safe to skip this step.
|
||||
|
||||
* **Glide:** This project uses `Glide` to manage dependencies as well
|
||||
as to provide *reproducible builds*. To install `Glide`, execute the
|
||||
following command (assumes you already have Go properly installed):
|
||||
```
|
||||
$ go get -u github.com/Masterminds/glide
|
||||
```
|
||||
* **btcd:** This project currently requires `btcd` with segwit support,
|
||||
which is not yet merged into the master branch. Instead,
|
||||
[roasbeef](https://github.com/roasbeef/btcd) maintains a fork with his
|
||||
segwit implementation applied. To install, please see
|
||||
[the installation instructions](docs/INSTALL.md).
|
||||
|
||||
With the preliminary steps completed, to install `lnd`, `lncli`, and all
|
||||
related dependencies run the following commands:
|
||||
```
|
||||
$ git clone https://github.com/lightningnetwork/lnd $GOPATH/src/github.com/lightningnetwork/lnd
|
||||
$ cd $GOPATH/src/github.com/lightningnetwork/lnd
|
||||
$ glide install
|
||||
$ go install . ./cmd/...
|
||||
```
|
||||
|
||||
### Updating
|
||||
To update your version of `lnd` to the latest version run the following
|
||||
commands:
|
||||
```
|
||||
$ cd $GOPATH/src/github.com/lightningnetwork/lnd
|
||||
$ git pull && glide install
|
||||
$ go install . ./cmd/...
|
||||
```
|
||||
|
||||
### Tests
|
||||
To check that `lnd` was installed properly run the following command:
|
||||
```
|
||||
go install; go test -v -p 1 $(go list ./... | grep -v '/vendor/')
|
||||
```
|
||||
|
||||
## IRC
|
||||
* irc.freenode.net
|
||||
* channel #lnd
|
||||
|
||||
Reference in new issue
Block a user