6bfeea334b
README.md: update link from listpayments to listpays.
Fixes : #2401
Reported-by: @stevenroose
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
6 years ago
af750d802d
Switch to libsodium-dev for ubuntu install instructions
6 years ago
0e34b9ac0e
readme: Add a readthedocs badge to show that we have nice docs :-)
Signed-off-by: Christian Decker <decker.christian@gmail.com>
6 years ago
17b969383b
Changed testnet faucet
The previous ones were no longer working.
This one currently does.
Signed-off-by: Mark Beckwith <wythe@intrig.com>
6 years ago
189fca4039
[doc] Remove old GOSSIPING state from docs
6 years ago
a92c7911a7
[docs]: Link developer guide to main README.md
6 years ago
6d2e5bace3
Copy-edit README.md
Fix a few typos and grammatical errors in the README file.
6 years ago
e904fcc00c
docker: Update docker images and docs to non-CVE-2018-17144 bitcoind
While not strictly necessary it's certainly a good idea to test
against the latest one and not encourage users to use old versions.
Reported-by: Jonas Nick <@jonasnick>
Signed-off-by: Christian Decker <@cdecker>
6 years ago
4a1bc0f90c
Add files via upload
6 years ago
e47ac33a37
Fix readme docker-compose port setting
6 years ago
80a8e57ede
Fix example docker-compose.yml
6 years ago
046a9c1a45
doc: document p2sh-segwit address gen for faucet coins
Now that the default newaddr type is bech32, this step seems to be tripping
people up.
Reported-by: #c-lightning users
Signed-off-by: William Casarin <jb55@jb55.com>
6 years ago
0b597f671a
added (or remotely) to README
7 years ago
ec55bf3b3f
README.md: 18332 is default bitcoind rpc port for testnet.
7 years ago
aeafe4dbe7
[Docker] Fix: Bind socat to the right port
7 years ago
0d3c3a225e
docker: Add a usable dockerfile
This is based on @NicolasDorier's excellent proposal for a Dockerfile, sans the
writing of a config file.
Co-authored-by: Nicolas Dorier <nicolas.dorier@gmail.com>
Co-authored-by: Christian Decker <decker.christian@gmail.com>
Signed-off-by: Christian Decker <decker.christian@gmail.com>
7 years ago
d9bd25cff8
README: Add ./configure to installation instructions
Now required, after changes in c49765553f
7 years ago
083a2cee07
zlib: add as a requirement.
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
7 years ago
700a505727
doc: Remove libsodium-dev dependency, it's in-tree
Signed-off-by: Christian Decker <decker.christian@gmail.com>
Reported-by: Perlover <@Perlover>
7 years ago
424ca8cf59
doc: Modify README.md code sections
7 years ago
e10a2b63ca
README.md: no need for segwit activation on regtest any more.
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
7 years ago
9504a77b44
Reflow README.md with no changes to text
Can be tested by calling a following script
#!/bin/sh
FILE=${1:-"CONTRIBUTING.md"}
CUR_BRANCH=$(git rev-parse --abbrev-ref HEAD)
{
git checkout $CUR_BRANCH
commonmarker $FILE | tidy > /tmp/aoeui.html
git checkout master >/dev/null
commonmarker $FILE | tidy | diff -u - /tmp/aoeui.html
git checkout $CUR_BRANCH
} 2>/dev/null
Formatted according to suggestion by @ZmnSCPxj described in
https://github.com/ElementsProject/lightning/pull/1137
7 years ago
ae6b901e78
README: add link to our shiny new mailinglist
7 years ago
cccdb53bec
channel_states: fold all the ONCHAIND states into one.
The billboard is now far more useful to tell what's going on, and this
gets us closer to a state == owner mapping.
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
7 years ago
3a5aa75fb6
A more detailed description of the "amount" field
The more frequent question I ask to myself when initiating channels regards the amount field.
In this document we have three different denominations and the modification proposed aims to address the possible doubts or errors.
The names <amount_in_bitcoins>, <amount_in_satoshis> or <amount_in_millisatoshis> (this last is omitted because the denomination is in the description) are not so elegant but they could serve the purpose.
7 years ago
fa8bcf2230
Include apt-get update as first step
For the impatient! First time users following these steps may get an error like "Unable to locate package libsodium-dev" if apt-get update is not run first.
7 years ago
97871237bf
README - change number of confirmations needed in fundchannel to 3
For mainnet, 1 for testnet
7 years ago
5d947b3a1f
README - note that bitcoind node pruning is not yet supported
7 years ago
e4d719a421
[doc] install: add libsodium-dev
7 years ago
93d5df559d
add docs about configuration file
7 years ago
326b17a1be
add readme badge
7 years ago
6a9f40f7cc
Different states explained
7 years ago
8bf9f28a79
doc: Specify that pruned nodes do not work currently
7 years ago
73c31757e1
Fixed and updated README RPC doc links
7 years ago
1616fcbffe
change getchannels to listchannels
7 years ago
0702ee6d81
Update to listpeers
See 5698a133c2
7 years ago
16455e658d
fix typo
7 years ago
2b6356f87a
Fix 'Receiving and receiving payments' in readme
Changed`Receiving and receiving payments` to `Sending and receiving payments` in the readme.
7 years ago
5357a6f02d
Sync dependencies between README.md and doc/INSTALL.md
Before this patch:
```
$ diff -u <(egrep 'sudo apt-get install .*git' README.md) <(egrep 'sudo apt-get install .*git' doc/INSTALL.md)
--- /dev/fd/63 2018-01-18 17:26:34.330464546 +0100
+++ /dev/fd/62 2018-01-18 17:26:34.330464546 +0100
@@ -1 +1 @@
-sudo apt-get install -y autoconf build-essential git libtool libgmp-dev libsqlite3-dev python python3 net-tools
+sudo apt-get install -y autoconf automake build-essential git libtool libgmp-dev libsqlite3-dev python python3 net-tools
$
```
After this patch:
```
$ diff -u <(egrep 'sudo apt-get install .*git' README.md) <(egrep 'sudo apt-get install .*git' doc/INSTALL.md)
$
```
7 years ago
69260adb38
quickfixing issue #662 to make CLI more userfriendly for inexperienced users ( #663 )
* making the cli more user friendly for inexperienced users #662
providing a quickfix for https://github.com/ElementsProject/lightning/issues/662
Basically I extended the ./lighting-cli --help message to at least state that one should use ./lighting-cli help, and added a hint to cli/lighting-cli help to the README
Closes : #662
7 years ago
5a87fb1c3b
Minor gramatical fixes
7 years ago
988118a629
Update README.md
Python is needed here as it looks like on newer versions of Ubuntu (i am on 16.04) it's not included by default.
7 years ago
575b733edd
Fix paren in README, add `autoconf` to dependencies
7 years ago
3f2d93de93
README: don't suggest low-level commands, talk about invoice, bolt11 and pay.
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
7 years ago
600cd0c2ad
README: Update to latest behavior: we no longer need addfunds command.
7 years ago
a8de8a3140
json_getchannels: add public flag.
Fixes : #509
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
7 years ago
0865c9f012
Make README.md install instructions consistent with doc/INSTALL.md
* Remove python2 dependency.
* Add net-tools dependency.
7 years ago
96f075c07e
readme: note about walletbroadcast
To save others the pain that I went through :[
Signed-off-by: William Casarin <jb55@jb55.com>
7 years ago
8512e2c8ef
README.md: Add link to waitanyinvoice
7 years ago
0353ec0983
Remove trailing whitespace
7 years ago
Rusty Russell
Conor Scott
Christian Decker
Mark Beckwith
Amin Shah Gilani
alan8325
Ronald Mannak
tock203
William Casarin
Jordan Baczuk
Jonathan Zernik
nicolas.dorier
Nadav Ivgi
Jan Sarenik
ZmnSCPxj, ZmnSCPxj jxPCSmnZ
gabridome
danielalexiuc
Jeff Weiss
Sjors Provoost
windsok
gdassori
Ronald van der Meer
alaniz
frennkie
Thijs van den Anker
practicalswift
renepickhardt
audiojak
ianthius
Eric Martindale