We haven't touched the readme for quite some time, just randomly added to it,
and it's starting to show. This is my attempt at cleaning it up a bit (more to
come):
- No longer discourage users from running on mainnet, we're way beyond that
point.
- No longer instruct users to build from source, when we have real binary
releases, on the PPA, the releases page and the docker images.
- Cut down on the docker specific instructions, they are taking a lot of room
when only a minority will likely run them that way
- Generally make the README more of a dispatch for more in-depth
documentation rather than trying to address everything right on the
front-page.
- Add a bit of context about running on top of a pruned node
Signed-off-by: Christian Decker <decker.christian@gmail.com>
Header from folded patch 'fixup!_readme__first_pass_at_homogenizing_the_readme_a_bit.patch':
fixup! readme: First pass at homogenizing the readme a bit
This makes it build for me on FreeBSD 11:
1. $(MAKE) has to passed through into update-mocks.
2. FreeBSD sed doesn't turn \n into a newline on RHS.
3. Bash and mako dependencies were missing from INSTALL.md
Fixes: #2850
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
* remove libbase58, use base58 from libwally
This removes libbase58 and uses libwally instead.
It allocates and then frees some memory, we may want to
add a function in wally that doesn't or override
wally_operations to use tal.
Signed-off-by: Lawrence Nahum lawrence@greenaddress.it
This is a preparatory step for the automatic documentation generation
that is going to use `sphinx-doc`. Each document should include a top
level header that matches the name and scope of the document and all
following headers should be of a lower level than the top-level
header.
Signed-off-by: Christian Decker <decker.christian@gmail.com>
Also one less headache for reproducible builds. But unlike
libsodium, this only seems common in Ubuntu.
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
We need sudo on all the commands, and we have more dependencies (esp. if
we want to do development).
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
Proposed fix for issue #1231 - FreeBSD (tcsh) build problem due
to HOST environment variable.
The variable is used for cross-compilation. The process may be
improved even further in the future. So far this hot fix.
These are basic instructions that lead to the build process completing without error (after a known error occurs and is rectified). For now, the final results are untested.
* build: update INSTALL.md to include Fedora #1028
* doc: Add TOC to INSTALL.md
* doc: Use lower case for anchors in TOC and minor changes
- anchors require lower case
- TOC doesn't work with dots, using OS names
* doc: improving FreeBSD doc
- Add missing packages: gmp and asciidoc
- Include step gmake install
This time the rendered output is slightly different, but mostly
because long preformatted lines are wrapped and contain an extra
continuation backslash now.
Like many I don't read any documentation besides the readme in the
repo, so I thought I could just pull some simple getting started info
into the readme to make it easy for people to get started :-)
arowser
lambrosini
Jacob Rapoport
darosior
lisa neigut
Christian Decker
Rusty Russell
sskender
GreenAddress
Conor Scott
Alekos Filini
fanquake
Sjors Provoost
Jan Sarenik
BT
Douglas Roark
Mark Beckwith
conanoc
Douglas Schilling Landgraf
Igor Cota
William Casarin
Carl Dong
ianthius
ZmnSCPxj, ZmnSCPxj jxPCSmnZ
Damian Mee
Sankalp Ghatpande