mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2024-11-20 02:27:51 +01:00
Code Issues Projects Releases Wiki Activity
3,749 Commits 30 Branches 190 Tags 193 MiB
2caeab506b
Commit Graph

59 Commits

Author SHA1 Message Date
Christian Decker
700a505727 doc: Remove libsodium-dev dependency, it's in-tree 
Signed-off-by: Christian Decker <decker.christian@gmail.com>
Reported-by: Perlover <@Perlover>
 2018-05-06 14:07:13 +02:00
Jan Sarenik
424ca8cf59 doc: Modify README.md code sections 2018-03-04 03:21:59 +01:00
Rusty Russell
e10a2b63ca README.md: no need for segwit activation on regtest any more. 
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
 2018-03-01 03:52:21 +00:00
Jan Sarenik
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
 2018-02-28 23:37:06 +01:00
ZmnSCPxj, ZmnSCPxj jxPCSmnZ
ae6b901e78 README: add link to our shiny new mailinglist 2018-02-23 19:09:48 +01:00
Rusty Russell
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>
 2018-02-23 18:02:00 +01:00
gabridome
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.
 2018-02-20 03:06:53 +00:00
danielalexiuc
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.
 2018-02-12 09:24:45 +01:00
Jeff Weiss
97871237bf README - change number of confirmations needed in fundchannel to 3 
For mainnet, 1 for testnet
 2018-02-10 22:44:07 +01:00
Jeff Weiss
5d947b3a1f README - note that bitcoind node pruning is not yet supported 2018-02-10 22:44:07 +01:00
Sjors Provoost
e4d719a421 [doc] install: add libsodium-dev 2018-02-05 10:48:52 +00:00
windsok
93d5df559d add docs about configuration file 2018-02-03 17:56:08 +01:00
gdassori
326b17a1be add readme badge 2018-02-03 17:55:14 +01:00
Ronald van der Meer
6a9f40f7cc Different states explained 2018-01-29 04:47:59 +00:00
Christian Decker
8bf9f28a79 doc: Specify that pruned nodes do not work currently 2018-01-27 02:27:35 +00:00
alaniz
73c31757e1 Fixed and updated README RPC doc links 2018-01-21 23:59:13 +00:00
frennkie
1616fcbffe change getchannels to listchannels 2018-01-21 14:25:38 +01:00
frennkie
0702ee6d81 Update to listpeers 
See 5698a133c2
 2018-01-21 14:25:38 +01:00
frennkie
16455e658d fix typo 2018-01-21 02:40:10 +01:00
Thijs van den Anker
2b6356f87a Fix 'Receiving and receiving payments' in readme 
Changed`Receiving and receiving payments` to `Sending and receiving payments` in the readme.
 2018-01-20 17:00:38 +01:00
practicalswift
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)
$
```
 2018-01-19 10:11:19 +00:00
renepickhardt
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
 2018-01-19 10:09:54 +00:00
audiojak
5a87fb1c3b Minor gramatical fixes 2018-01-18 11:42:57 +01:00
ianthius
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.
 2018-01-18 11:42:07 +01:00
Eric Martindale
575b733edd Fix paren in README, add autoconf to dependencies 2018-01-17 16:22:44 +01:00
Rusty Russell
3f2d93de93 README: don't suggest low-level commands, talk about invoice, bolt11 and pay. 
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
 2018-01-14 23:10:10 +00:00
ZmnSCPxj
600cd0c2ad README: Update to latest behavior: we no longer need addfunds command. 2018-01-13 11:20:22 +01:00
Rusty Russell
a8de8a3140 json_getchannels: add public flag. 
Fixes: #509
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
 2018-01-08 18:09:31 +01:00
practicalswift
0865c9f012 Make README.md install instructions consistent with doc/INSTALL.md 
* Remove python2 dependency.
* Add net-tools dependency.
 2018-01-08 09:46:54 +00:00
William Casarin
96f075c07e readme: note about walletbroadcast 
To save others the pain that I went through :[

Signed-off-by: William Casarin <jb55@jb55.com>
 2018-01-08 09:43:31 +00:00
ZmnSCPxj
8512e2c8ef README.md: Add link to waitanyinvoice 2017-12-14 03:07:20 +00:00
practicalswift
0353ec0983 Remove trailing whitespace 2017-12-11 03:35:59 +00:00
practicalswift
61c47c09d0 Fix typos 2017-12-08 13:07:20 +01:00
Rusty Russell
af5dbbc9f8 json_connect: separate port arg so we can parse IPv6 addresses. 
Fixes: #391
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
 2017-12-04 11:15:59 +01:00
Rusty Russell
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>
 2017-12-04 10:06:34 +01:00
Jonas Nick
d07b827050 Mention in README that 6 confirmations are required to fund a channel 2017-11-13 16:26:34 +01:00
Jonas Nick
2543bc81b9 Fix docker tag in README 2017-11-04 11:35:32 +01:00
Rusty Russell
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>
 2017-10-20 18:31:32 +02:00
Christian Decker
48b876e401 doc: cli is no longer in the daemon subdirectory 
Closes #271

Reported-by: @sumBTC
Signed-off-by: Christian Decker <decker.christian@gmail.com>
 2017-09-09 19:22:01 +02:00
Rusty Russell
9da5abc39c docs: update, move into doc/ 
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
 2017-08-29 17:54:14 +02:00
Rusty Russell
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>
 2017-08-29 17:54:14 +02:00
Rusty Russell
8088e5cadb protobuf: remove 
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
 2017-08-29 17:54:14 +02:00
analogic
5db4e1144b Minor typo at docker execution 2017-08-28 17:52:01 +02:00
lokoga1
1b3eeec8f1 Update README.md for regtest 2017-08-22 16:00:20 +02:00
Christian Decker
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>
 2017-08-12 12:08:11 +02:00
Christian Decker
b1ded66d35 fix: Mispelled word in the README.md 
Fixes #198

Reported-by: Toshiro Takahashi @toshirot
Signed-off-by: Christian Decker <decker.christian@gmail.com>
 2017-07-31 13:45:13 +02:00
Christian Decker
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 :-)
 2017-05-20 20:02:45 +09:30
Sankalp Ghatpande
8c73f37869 Added another faucet, removed redundent dependency installation instructions 2017-05-09 00:03:17 +02:00
Rusty Russell
6905cf5e7f README.md: add "upgrade" instructions and add port config for public nodes. 
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
 2016-11-21 10:21:41 +10:30
Rusty Russell
0713de1db1 README.md: User instructions. 
Just in case we get any.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
 2016-10-19 12:09:19 +10:30