highperfocused/lnd
1
0
Fork 0
mirror of https://github.com/lightningnetwork/lnd.git synced 2025-11-10 06:07:16 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: add installation instructions

Browse Source
This commit is contained in:
Alex
2017-01-05 17:35:09 -07:00
committed by Olaoluwa Osuntokun
parent d7b36c6f31
commit e91c1b8136
2 changed files with 109 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@@ -11,19 +11,23 @@ Don't try to port it to mainnet or an altcoin and use it today! No really. Lig
## Installation
* In order to build form source, the following build dependancies are required:
* In order to build form source, the following build dependancies are required:
* **Go 1.5 or 1.6**
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 depdnancies as well as to provide *reproducable builds*.
To install `Glide`, execute the following command (assumes you already have Go properly installed):
`$ go get -u github.com/Masterminds/glide`
With the prelimnary steps completed, to install `lnd`, `lncli`, and all related depenancies run the following commands:
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 depdnancies as well as to provide *reproducable 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 merged yet. To install,
please see [the installation instructions](docs/INSTALL.md).
With the prelimnary steps completed, to install `lnd`, `lncli`, and all related depenancies run the following commands:
```
$ git clone https://github.com/lightningnetwork/lnd $GOPATH/src/github.com/lightningnetwork/lnd
@@ -33,7 +37,7 @@ $ go install . ./cmd/...
```
## Updating
To update your version of `lnd` to the latest version run the following commands:
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