Skip to content

Commit 10605cf

Browse files
ffranrffranr
committed
docs: archive compatibility table and trim README guidance
Move the LiT/LND compatibility matrix into docs/compatibility.md for archival so future releases no longer require README updates to adjust the table. Update README to direct users to release notes for minimum lnd versions and fall back to the archived table when not specified.
1 parent c9d1915 commit 10605cf

File tree

2 files changed

+80
-67
lines changed

2 files changed

+80
-67
lines changed

‎README.md‎

Lines changed: 8 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -67,75 +67,16 @@ If you’d prefer to compile from source code please follow [these instructions]
6767
## Compatibility
6868

6969
Full Lightning Terminal functionality can be dependent on running a compatible
70-
version of `lnd`. View the table below to ensure that you run a compatible
71-
version of `lnd` with the relevant `litd` release.
72-
73-
This version compatibility dependency table is only relevant when running litd
74-
in remote mode (meaning that `lnd-mode=remote` is set). It shows the
75-
**_minimum_** `lnd` version that can be used with different versions of `litd`
76-
(LiT). The bundled version will always come with the correct,
70+
version of `lnd`. For each LiT release, the minimum compatible `lnd` version
71+
should be specified in the [GitHub release
72+
notes](https://github.com/lightninglabs/lightning-terminal/releases). If a
73+
release note does not list it (for example, older releases), see the archived
74+
compatibility table in [docs/compatibility.md](./docs/compatibility.md).
75+
76+
This compatibility requirement only applies when running LiT in remote mode
77+
(`lnd-mode=remote`). The bundled version will always come with the correct,
7778
[compatible versioning](#daemon-versions-packaged-with-lit).
7879

79-
| LiT | LND |
80-
|-------------------|--------------|
81-
| **v0.16.0-alpha** | v0.19.0-beta |
82-
| **v0.15.3-alpha** | v0.19.0-beta |
83-
| **v0.15.2-alpha** | v0.19.0-beta |
84-
| **v0.15.1-alpha** | v0.19.0-beta |
85-
| **v0.15.0-alpha** | v0.19.0-beta |
86-
| **v0.14.1-alpha** | v0.18.5-beta |
87-
| **v0.14.0-alpha** | v0.18.4-beta |
88-
| **v0.13.6-alpha** | v0.17.1-beta |
89-
| **v0.13.5-alpha** | v0.17.1-beta |
90-
| **v0.13.4-alpha** | v0.17.1-beta |
91-
| **v0.13.3-alpha** | v0.17.1-beta |
92-
| **v0.13.2-alpha** | v0.17.0-beta |
93-
| **v0.13.1-alpha** | v0.17.0-beta |
94-
| **v0.13.0-alpha** | v0.17.0-beta |
95-
| **v0.12.5-alpha** | v0.17.0-beta |
96-
| **v0.12.4-alpha** | v0.17.0-beta |
97-
| **v0.12.3-alpha** | v0.16.0-beta |
98-
| **v0.12.2-alpha** | v0.16.0-beta |
99-
| **v0.12.1-alpha** | v0.16.0-beta |
100-
| **v0.12.0-alpha** | v0.16.0-beta |
101-
| **v0.11.0-alpha** | v0.16.0-beta |
102-
| **v0.10.5-alpha** | v0.16.0-beta |
103-
| **v0.10.4-alpha** | v0.16.0-beta |
104-
| **v0.10.2-alpha** | v0.16.0-beta |
105-
| **v0.10.1-alpha** | v0.16.0-beta |
106-
| **v0.10.0-alpha** | v0.16.0-beta |
107-
| **v0.9.2-alpha** | v0.16.0-beta |
108-
| **v0.9.1-alpha** | v0.16.0-beta |
109-
| **v0.9.0-alpha** | v0.16.0-beta |
110-
| **v0.8.6-alpha** | v0.15.4-beta |
111-
| **v0.8.5-alpha** | v0.15.4-beta |
112-
| **v0.8.4-alpha** | v0.15.1-beta |
113-
| **v0.8.3-alpha** | v0.15.1-beta |
114-
| **v0.8.2-alpha** | v0.15.1-beta |
115-
| **v0.8.1-alpha** | v0.15.1-beta |
116-
| **v0.8.0-alpha** | v0.15.1-beta |
117-
| **v0.7.1-alpha** | v0.14.3-beta |
118-
| **v0.7.0-alpha** | v0.14.3-beta |
119-
| **v0.6.7-alpha** | v0.13.3-beta |
120-
| **v0.6.6-alpha** | v0.13.3-beta |
121-
| **v0.6.5-alpha** | v0.13.3-beta |
122-
| **v0.6.4-alpha** | v0.13.3-beta |
123-
| **v0.6.3-alpha** | v0.13.3-beta |
124-
| **v0.6.2-alpha** | v0.13.3-beta |
125-
| **v0.6.1-alpha** | v0.13.3-beta |
126-
| **v0.6.0-alpha** | v0.13.3-beta |
127-
| **v0.5.2-alpha** | v0.12.0-beta |
128-
| **v0.5.1-alpha** | v0.12.0-beta |
129-
| **v0.5.0-alpha** | v0.12.0-beta |
130-
| **v0.4.1-alpha** | v0.11.1-beta |
131-
| **v0.4.0-alpha** | v0.11.1-beta |
132-
| **v0.3.4-alpha** | v0.11.1-beta |
133-
| **v0.3.3-alpha** | v0.11.1-beta |
134-
| **v0.3.2-alpha** | v0.11.1-beta |
135-
| **v0.3.1-alpha** | v0.11.1-beta |
136-
| **v0.3.0-alpha** | v0.11.1-beta |
137-
| **v0.2.0-alpha** | v0.11.0-beta |
138-
13980
LiT offers two main operating modes, one in which [`lnd` is running inside the
14081
LiT process (called "lnd integrated mode", set by `lnd-mode=integrated` config
14182
option)](docs/config-lnd-integrated.md) and one in which [`lnd` is running in

‎docs/compatibility.md‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
# LiT and LND compatibility
2+
3+
Full Lightning Terminal functionality can be dependent on running a compatible
4+
version of `lnd`. For new releases, the minimum required `lnd` version should be
5+
specified in the GitHub release notes. If a release note does not mention it
6+
(for example, older releases), refer to the archived compatibility table below.
7+
8+
This version compatibility dependency table is only relevant when running LiT in
9+
remote mode (meaning that `lnd-mode=remote` is set). It shows the **minimum**
10+
`lnd` version that can be used with different versions of `litd` (LiT). The
11+
bundled version will always come with the correct,
12+
[compatible versioning](../README.md#daemon-versions-packaged-with-lit).
13+
14+
| LiT | min LND version |
15+
|-------------------|-----------------|
16+
| **v0.16.0-alpha** | v0.19.0-beta |
17+
| **v0.15.3-alpha** | v0.19.0-beta |
18+
| **v0.15.2-alpha** | v0.19.0-beta |
19+
| **v0.15.1-alpha** | v0.19.0-beta |
20+
| **v0.15.0-alpha** | v0.19.0-beta |
21+
| **v0.14.1-alpha** | v0.18.5-beta |
22+
| **v0.14.0-alpha** | v0.18.4-beta |
23+
| **v0.13.6-alpha** | v0.17.1-beta |
24+
| **v0.13.5-alpha** | v0.17.1-beta |
25+
| **v0.13.4-alpha** | v0.17.1-beta |
26+
| **v0.13.3-alpha** | v0.17.1-beta |
27+
| **v0.13.2-alpha** | v0.17.0-beta |
28+
| **v0.13.1-alpha** | v0.17.0-beta |
29+
| **v0.13.0-alpha** | v0.17.0-beta |
30+
| **v0.12.5-alpha** | v0.17.0-beta |
31+
| **v0.12.4-alpha** | v0.17.0-beta |
32+
| **v0.12.3-alpha** | v0.16.0-beta |
33+
| **v0.12.2-alpha** | v0.16.0-beta |
34+
| **v0.12.1-alpha** | v0.16.0-beta |
35+
| **v0.12.0-alpha** | v0.16.0-beta |
36+
| **v0.11.0-alpha** | v0.16.0-beta |
37+
| **v0.10.5-alpha** | v0.16.0-beta |
38+
| **v0.10.4-alpha** | v0.16.0-beta |
39+
| **v0.10.2-alpha** | v0.16.0-beta |
40+
| **v0.10.1-alpha** | v0.16.0-beta |
41+
| **v0.10.0-alpha** | v0.16.0-beta |
42+
| **v0.9.2-alpha** | v0.16.0-beta |
43+
| **v0.9.1-alpha** | v0.16.0-beta |
44+
| **v0.9.0-alpha** | v0.16.0-beta |
45+
| **v0.8.6-alpha** | v0.15.4-beta |
46+
| **v0.8.5-alpha** | v0.15.4-beta |
47+
| **v0.8.4-alpha** | v0.15.1-beta |
48+
| **v0.8.3-alpha** | v0.15.1-beta |
49+
| **v0.8.2-alpha** | v0.15.1-beta |
50+
| **v0.8.1-alpha** | v0.15.1-beta |
51+
| **v0.8.0-alpha** | v0.15.1-beta |
52+
| **v0.7.1-alpha** | v0.14.3-beta |
53+
| **v0.7.0-alpha** | v0.14.3-beta |
54+
| **v0.6.7-alpha** | v0.13.3-beta |
55+
| **v0.6.6-alpha** | v0.13.3-beta |
56+
| **v0.6.5-alpha** | v0.13.3-beta |
57+
| **v0.6.4-alpha** | v0.13.3-beta |
58+
| **v0.6.3-alpha** | v0.13.3-beta |
59+
| **v0.6.2-alpha** | v0.13.3-beta |
60+
| **v0.6.1-alpha** | v0.13.3-beta |
61+
| **v0.6.0-alpha** | v0.13.3-beta |
62+
| **v0.5.2-alpha** | v0.12.0-beta |
63+
| **v0.5.1-alpha** | v0.12.0-beta |
64+
| **v0.5.0-alpha** | v0.12.0-beta |
65+
| **v0.4.1-alpha** | v0.11.1-beta |
66+
| **v0.4.0-alpha** | v0.11.1-beta |
67+
| **v0.3.4-alpha** | v0.11.1-beta |
68+
| **v0.3.3-alpha** | v0.11.1-beta |
69+
| **v0.3.2-alpha** | v0.11.1-beta |
70+
| **v0.3.1-alpha** | v0.11.1-beta |
71+
| **v0.3.0-alpha** | v0.11.1-beta |
72+
| **v0.2.0-alpha** | v0.11.0-beta |

0 commit comments

Comments
 (0)