From e437f6bd5717d7c3ef290b4e88aca22dd434dc71 Mon Sep 17 00:00:00 2001 From: Antoine Poinsot Date: Tue, 30 May 2023 15:46:12 +0200 Subject: [PATCH] doc: mention the minimum supported glibc version --- README.md | 22 ++++++++++++++++++++-- doc/TRY.md | 8 ++++++-- 2 files changed, 26 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index b5bc97b1..81a3d96e 100644 --- a/README.md +++ b/README.md @@ -43,8 +43,11 @@ source, see [`doc/BUILD.md`](doc/BUILD.md) instead. Head to the [release page](https://github.com/wizardsardine/liana/releases) and download the right executable for your platform. If you are not sure what is the "right" executable for your platform, -choose `liana-1.0.exe` if you are on Windows, `Liana.zip` if you are on MacOS and -`liana-1.0-x86_64-linux-gnu.tar.gz` if you are on Linux. +choose: +- `Liana.zip` if you are on MacOS, +- `liana-1.0.exe` if you are on Windows, +- `liana-1.0-x86_64-linux-gnu.tar.gz` if you are on Linux. Note you may have to compile the software + yourself if you are on Linux. See the [section below](#a-note-on-linux-binaries-and-glibc-version). For every file available on the release page, there is an accompanying `.asc` file with the same name. This is a GPG signature made with Antoine Poinsot's key: @@ -53,6 +56,21 @@ as on [his Twitter profile](https://twitter.com/darosior) or his [personal website](http://download.darosior.ninja/darosior.pub). It is recommended you verify your download against this key. +#### A note on Linux binaries and glibc version + +*Skip this section if you are not running Linux or don't plan on using a released binary.* + +Due to technical limitations in our reproducible builds system, the Linux binaries currently link +against `glibc` version `2.33`. This means you can't run a released Linux binary if your system has +an older glibc. This is the case most notably of Ubuntu 20 (Focal) and below, and Debian 11 +(Bullseye) and below. + +The simplest workaround is to simply build the project yourself. Fear not, it's really trivial if +you are a Linux user. Instructions [here](doc/BUILD.md). + +See [this issue](https://github.com/wizardsardine/liana/issues/414) for details. + + #### Apple, Windows, codesigned and notarized binaries We distribute both a non-codesigned and a codesigned-and-notarized MacOS application diff --git a/doc/TRY.md b/doc/TRY.md index f33c0c7e..bc0a8d68 100644 --- a/doc/TRY.md +++ b/doc/TRY.md @@ -105,8 +105,12 @@ handful of minutes). You can track the progress using the `getblockchaininfo` co Head to the [release page](https://github.com/wizardsardine/liana/releases) and download the right executable for your platform. If you are not sure what is the "right" executable for your platform, -choose `liana-0.3.exe` if you are on Windows, `liana-0.3.dmg` if you are on MacOS and -`liana-0.3-x86_64-linux-gnu.tar.gz` if you are on Linux. +choose `Liana.zip` if you are on MacOS, `liana-1.0.exe` if you are on Windows, and +`liana-1.0-x86_64-linux-gnu.tar.gz` if you are on Linux. + +A note for **Linux users only**: released binaries may not be working on your system if it is +running a too old glibc. In this case you may have to build from source. See the [short section +about this in the README](../README.md#a-note-on-linux-binaries-and-glibc-version). For every file available on the release page, there is an accompanying `.asc` file with the same name. This is a GPG signature made with Antoine Poinsot's key: