d9bd25cff8
README: Add ./configure to installation instructions
Now required, after changes in c49765553f
6 years ago
083a2cee07
zlib: add as a requirement.
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
6 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
61c47c09d0
Fix typos
7 years ago
af5dbbc9f8
json_connect: separate port arg so we can parse IPv6 addresses.
Fixes : #391
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
7 years ago
45e9f35988
docs: Note that we need 0.15 (for estimatesmartfee with CONSERVATIVE/ECONOMCIAL flags)
Closes : #392
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
7 years ago
d07b827050
Mention in README that 6 confirmations are required to fund a channel
7 years ago
2543bc81b9
Fix docker tag in README
7 years ago
98ad6b9231
lightningd: change connect RPC args.
We're going to make the ip/port optional, so they should go at the end.
In addition, using ip:port is nicer, for gethostbyaddr().
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
7 years ago
48b876e401
doc: cli is no longer in the daemon subdirectory
Closes #271
Reported-by: @sumBTC
Signed-off-by: Christian Decker <decker.christian@gmail.com>
7 years ago
9da5abc39c
docs: update, move into doc/
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
7 years ago
8375857116
common: absorb remaining files from daemon/
Also, we split the more sophisticated json_add helpers to avoid pulling in
everything into lightning-cli, and unify the routines to print struct
short_channel_id (it's ':', not '/' too).
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
7 years ago
8088e5cadb
protobuf: remove
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
7 years ago
5db4e1144b
Minor typo at docker execution
7 years ago
1b3eeec8f1
Update README.md for regtest
7 years ago
f802e98e73
doc: Fix sendpay instructions
They were telling people to use the `<amount>`, but that's encoded in
the route already. Instead the final parameter is the `<rhash>` which
is the only piece of information missing for the transfer.
Reported-by: Toshiro Takahashi @toshirot
Signed-off-by: Christian Decker <decker.christian@gmail.com>
7 years ago
b1ded66d35
fix: Mispelled word in the README.md
Fixes #198
Reported-by: Toshiro Takahashi @toshirot
Signed-off-by: Christian Decker <decker.christian@gmail.com>
7 years ago
744d657860
doc: Updating README and related documentation
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 :-)
8 years ago
8c73f37869
Added another faucet, removed redundent dependency installation instructions
8 years ago
Nadav Ivgi
Rusty Russell
Christian Decker
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
William Casarin
Jonas Nick
analogic
lokoga1
Sankalp Ghatpande