Commit Graph

163 Commits

Author SHA1 Message Date
Oliver Gugger
2b163480cf
docs: bitcoind is required for unit tests 2019-11-06 09:47:48 +01:00
Oliver Gugger
ae04bdb98a
doc: describe macaroon bakery 2019-11-04 15:07:24 +01:00
Vignesh Karthikeyan
2520d0a996
Fix Formatting of *Wrong*
There is a spacing issues, and thus a formatting 
issue, in the file, code_contribution_guidelines.md
2019-10-19 16:48:32 +05:30
Wilmer Paulino
c05b8f88ac
docs: update watchtower docs to include wtclientrpc info 2019-09-25 14:41:27 -07:00
Olaoluwa Osuntokun
6691c039ec
docs: update docs to build using go 1.13 2019-09-11 05:56:47 -07:00
Spencer Dupre
e2d5825df0 docs: update INSTALL.md to include first wallet creation (#3403)
Add 'Creating a wallet' section, explaining that 'lncli create' must be run
with a new instance. Also describe the password prompt and mnemonic this
command presents to the user.
2019-09-09 02:37:23 -07:00
Brett Cawley
9d213948ba docs/grpc: add C# docs 2019-07-12 13:23:31 -07:00
Turtle
47609a511e MAKEFILE: Clarify what the testcase argument is 2019-07-11 00:37:30 -04:00
exfrog
f98b737cfe
Update recovery.md
minor typo on line 286, said 'implement' twice
2019-07-10 16:04:55 -07:00
Conner Fromknecht
2440e9c2e5
docs/watchtower.md: add watchtower guide 2019-07-01 15:57:21 -07:00
Olaoluwa Osuntokun
5fc6cbc6d8
docs: add new recovery.md explaning methods of fund recovery 2019-04-11 16:56:57 -07:00
Philipp Gille
c99c1f59f3 docs: update Go version from 1.11 to 1.12
- Also changed "go" to "Go" when used as a name
- Also changed "http" to "https" for two URLs that support HTTPS
2019-04-10 21:15:18 +02:00
Wilmer Paulino
73791e15a1
Merge pull request #2830 from philippgille/feature/update-contribution-checklist
docs: update contribution checklist
2019-04-05 15:46:34 -07:00
Conner Fromknecht
209c2c6ead
Merge pull request #2841 from philippgille/patch-4
docs: fix broken TOC in Tor docs
2019-04-05 15:35:50 -07:00
Olaoluwa Osuntokun
d736454599
Merge pull request #2831 from philippgille/patch-3
docs/MAKEFILE: Remove mention of dep and Glide
2019-03-26 20:54:38 -07:00
Philipp Gillé
58a86011cc
docs: fix broken TOC in Tor docs
- Remove TOC entries of removed docs sections
- Add hint about complete inbound connection docs section after command
  examples for inbound connections to prevent people from overseeing the
  listen=localhost flag
2019-03-26 19:26:46 +01:00
Philipp Gillé
449707d90a
docs/MAKEFILE: Remove mention of dep and Glide
Commit ca28c0b removed the dep section,
so it shouldn't be mentioned as a target in other targets.
Also, Glide doesn't seem to be used anymore as well.
2019-03-24 13:28:51 +01:00
Philipp Gille
dd3f48eda5 docs: update contribution checklist
- Update Go version 1.11 to 1.12
- Fix broken link in GitHub PR template
- Fix inconsistent number of spaces after checkbox
- Add proper link to "Ideal Git Commit structure"
2019-03-24 11:37:57 +01:00
Philipp Gillé
8b568296df
docs: fix typo 2019-03-23 17:03:40 +01:00
Thomas Braunberger
fab742141f fix links to BIP 157 and 158 2019-02-27 10:01:34 +01:00
Gfloresechaiz
02617875c0
Update INSTALL.md 2019-02-20 19:30:23 -05:00
Joost Jager
9e012ecc93
multi: move Input interface and related code
This commit is a step to split the lnwallet package. It puts the Input
interface and implementations in a separate package along with all their
dependencies from lnwallet.
2019-01-31 13:25:33 +01:00
Olaoluwa Osuntokun
9cda05ee8a
docs: add new section to contribution guidelines for go mod replace
In this commit, we add a new section to the code contribution guidelines
explaining how to use `go mod replace`. This will be a common procedure
for any developer that needs to make a change in any of our sister
projects, so it's nice to have this outlined in a single place.
2019-01-17 16:50:06 -08:00
Olaoluwa Osuntokun
c3ebe6c77d
Merge pull request #2402 from Roasbeef/update-install-directions
docs/INSTALL.md: update Go installation options for Linux
2019-01-17 16:33:06 -08:00
Web Worker
697217630e
Fix TOC link 2019-01-04 12:37:52 -05:00
Olaoluwa Osuntokun
d8a991ee68
docs/INSTALL.md: pin brew install against go 1.11 2019-01-02 15:14:46 -08:00
Olaoluwa Osuntokun
11dac33c6f
docs/INSTALL.md: update Go installation options for Linux
In this commit, we modify the Linux installation instructions to use the
pre-built archives rather than install from the ppa. We do this as
typically the ppa lags behind the latest releases, and also by
downloading it in this new manner, we're able to verify the sha256 sum
of the installed Go release.
2019-01-02 15:11:19 -08:00
Vincent Woo
5f1d859c0a Show in gRPC Ruby doc how to avoid GRPC::ResourceExhausted exceptions
Otherwise mainnet DescribeGraph calls will fail
2018-12-26 14:02:29 -08:00
Olaoluwa Osuntokun
af306e2360
docs: expand contributor checklist w/ commit structure 2018-12-19 17:02:25 -08:00
Olaoluwa Osuntokun
49da4a60aa
docs: update contribution guidelines with new merge commit policy 2018-12-18 20:59:58 -08:00
Olaoluwa Osuntokun
a76affae91
docs: replace golint with make lint in contributor guidelines 2018-12-18 20:59:56 -08:00
Olaoluwa Osuntokun
0d5eef4f30
docs: in contributor guidelines, use make check not go test 2018-12-18 20:59:54 -08:00
Olaoluwa Osuntokun
ce39910f96
docs: add section in contribution guidelines describing fixup commits 2018-12-18 20:59:53 -08:00
Olaoluwa Osuntokun
d1571badaf
docs: add section in contribution guidelines for unique lnd code style 2018-12-18 20:59:52 -08:00
Olaoluwa Osuntokun
0dc9b35a1a
docs: add section in testing pointing towards Makefile docs 2018-12-18 20:59:51 -08:00
Olaoluwa Osuntokun
516a48741f docs: update contribution guidelines to add section on commit structure 2018-12-18 20:59:46 -08:00
Olaoluwa Osuntokun
c355acb59d
docs: revamp INSTALL.md
In this commit, we aim to revamp the `INSTALL.md` file in order to make
it easier to parse, and more explicit. We've added a table of contents
to allow users to skip down to relevant sections and obtain a snapshot
of the contents of the document. Additionally, we've now modified the
headings to express a more clear delineation of the various sections.
2018-12-13 13:54:23 -08:00
Olaoluwa Osuntokun
eda45adb5b
docs: update docs to reflect new go modules usage and building 2018-11-28 20:13:56 -08:00
Olaoluwa Osuntokun
e6c22d658d
docs: update contribution guidelines to reference latest version of Go
with '#' will be ignored, and an empty message aborts the commit.
2018-11-28 20:13:50 -08:00
Olaoluwa Osuntokun
f09a4daeb1
docs/MAKEFILE: remove obsolete travis section
In this commit, we remove the travis section as the directive has been
removed from the makefile.
2018-11-28 20:13:49 -08:00
Olaoluwa Osuntokun
ca28c0b5a1
docs/MAKEFILE: remove dep section
In this commit, we remove the dep section as we no longer use it, and
instead use go modues.
2018-11-28 20:13:48 -08:00
Carlos Garcia Ortiz
0f03120a46 Docs: code_contribution_guidelines change link 2018-11-27 10:20:06 +01:00
Xavi Soler
ca9f572766 add num_inactive_channels field to docs 2018-11-05 09:11:01 +01:00
Johan T. Halseth
08c2ee05f6
Merge pull request #2107 from vwoo/grpc-ruby-doc-macaroon
gRPC ruby doc updates
2018-10-31 08:26:56 +01:00
Oscar Lafarga
832bd8101c docs: update INSTALL.md
- Provides clarity to the sample `lnd.conf` to reduce friction on a first-time mainnet set up of lnd (avoiding the `loadConfig: debug-htlc mode cannot be used on bitcoin mainnet` error)

- Removes `debughtlc` from the sample `lnd.conf` since it is not something most people would use anymore
- Adds link to `sample-lnd.conf` with proper line-wrapping
2018-10-29 15:39:35 -07:00
Olaoluwa Osuntokun
3b9aa2e7b5
Merge pull request #2053 from BobleChinois/docs/configuring_tor
update 'configuring_tor' file
2018-10-26 17:13:09 -07:00
Vincent Woo
8103db60de Show how macaroon interceptor can work with streaming gRPC in Ruby doc 2018-10-26 14:17:35 -07:00
Vincent Woo
6dd4fde56a Fix incorrect hash key in gRPC Ruby documentation 2018-10-26 13:24:30 -07:00
Boblechinois
5aad6768b3 update 'configuring_tor' file 2018-10-15 14:25:12 +02:00
bob-333
c7bbc9e4b3
Update INSTALL.md
Every time I try to update lnd by following these instructions it fails. Most recently like this:

    $ make
     Compiling dependencies.
    dep ensure -v
    # Bringing vendor into sync
    grouped write of manifest, lock and vendor: failed to export github.com/lightninglabs/neutrino: fatal: failed to unpack tree object 838f7ba74d217d188efc223604bd280b4e3f0238
    : exit status 128
    Makefile:116: recipe for target 'dep' failed
    make: *** [dep] Error 1

I found that if I `make clean` before running `make` then it doesn't fail.
2018-10-09 09:39:35 -07:00