Update README with general build instructions
This commit is contained in:
parent
5bddb611dc
commit
80b20bd039
13
README.md
13
README.md
@ -8,6 +8,19 @@ This version of Lnd is not yet fully-operational, but a proof of concept on test
|
||||
|
||||
Don't try to port it to mainnet or an altcoin and use it today! No really. Lightning transactions will be fast, but for now, please wait just a little bit.
|
||||
|
||||
## Installation
|
||||
|
||||
* If necessary, install Go according to the installation instructions here: http://golang.org/doc/install. It is recommended to add `$GOPATH/bin` to your `PATH` at this point.
|
||||
* Run the following command to obtain and install lnd, lncli, lnshell and all dependencies:
|
||||
|
||||
```
|
||||
go get -u -v github.com/LightningNetwork/lnd/...
|
||||
```
|
||||
|
||||
Feel free to disregard any errors/warnings related to the lnstate and uspv packages.
|
||||
|
||||
## Packages and Utilities
|
||||
|
||||
### chainntfs
|
||||
|
||||
A package centered around a generic interface for receiving transaction/confirmation based notifications concerning the blockchain. Such notifications are required in order for pending payment channels to be notified once the funding transaction gains a specified number of confirmations, and in order to catch a counter-party attempting a non-cooperative close using a past commitment transaction to steal funds.
|
||||
|
Loading…
Reference in New Issue
Block a user