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
Olaoluwa Osuntokun
3fda1029c0
Merge pull request #1786 from Roasbeef/golang-1.1
...
build+docs: bump to golang 1.11
2018-10-08 13:26:07 +09:00
Olaoluwa Osuntokun
233246714d
build+docs: bump to golang 1.11
2018-10-07 11:28:49 +09:00
Conner Fromknecht
c2d9cb11d3
docs/MAKEFILE: add log params to unit test targets
2018-10-05 13:04:45 +09:00
Olaoluwa Osuntokun
6afee3d099
Merge pull request #1856 from maurycy/typos
...
multi: fix various typos in comments
2018-09-27 20:38:10 -07:00
Olaoluwa Osuntokun
c5ece1e509
Merge pull request #1843 from cfromknecht/change-noencryptwallet
...
Start deprecating noencryptwallet
2018-09-12 21:07:23 -07:00
Wilmer Paulino
18528e9f3f
docs: update v3 tor docs
2018-09-11 19:37:13 -07:00
maurycy
ac24b12bf2
multi: fix various typos in comments
2018-09-07 06:51:49 +02:00
Conner Fromknecht
e47412be3a
docs/INSTALL: remove noencryptwallet from install docs
...
We will be slowly phasing this out, though abruptly
discontinuing support would be a more extensive change.
For now, we will ensure that this feature is not
recommended to users setting up a new wallet.
2018-09-04 20:52:43 -07:00
Wilmer Paulino
dc3db4bf62
docs: update path to where macaroons are stored
...
Co-Authored-By: Karl Ranna <karl@karlranna.com>
2018-08-23 18:05:00 -07:00
Wilmer Paulino
41379c9c73
docs: fix lnd w/ bitcoind backend example command
2018-08-09 23:54:47 -07:00
Wilmer Paulino
e58486b599
docs: note that different ZMQ sockets must be used with bitcoind
2018-08-08 20:26:31 -07:00
Olaoluwa Osuntokun
a34a4661e8
docs: update installation instructions to point to btcsuite/btcd not roasbeef/btcd
2018-07-13 17:08:46 -07:00
Olaoluwa Osuntokun
6f60f139f4
multi: switch over import paths from roasbeef/* to btcsuite/*
2018-07-13 17:05:39 -07:00
Conner Fromknecht
a3acd9c23f
docs/INSTALL: fix mismatched code blocks
2018-07-10 19:03:06 -07:00
Dan Bolser
d0d77f9718
README: add known good FreeBSD (9.11) instructions
2018-07-10 16:53:34 -07:00
Matthew Lilley
c571b04236
Add make instructions for Windows WSL users
2018-06-30 00:48:31 +01:00
Brenden Matthews
c703418d1a
docs: Add starter doc on debugging lnd.
2018-06-25 16:27:58 -04:00
Olaoluwa Osuntokun
fc658dbf60
docs: further clarify --txindex usage for full nodes
2018-06-18 14:01:25 +01:00
Dan Bolser
b5d8cde6fc
README: update README to indicate tx index is no longer required for full node backends
2018-06-18 05:58:24 -07:00
Wilmer Paulino
c1886d2c1c
docs: add NAT traversal related documentation
2018-06-12 18:40:13 -07:00
Wilmer Paulino
5b58d24f78
docs: update documentation for inbound connections
2018-06-04 20:41:47 -07:00
Rudy Godoy
3ee4f5fbd4
docs/docker: fixed link to /docker/README.md
...
Link must be /docker/README.md, relative to the repository's root. Previously it was relative to /docs, resulting in 404.
2018-06-04 16:13:17 -07:00