From 36d2e3cf74a536fea096749809dbff989fd240e7 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Mart=C3=ADn=20Fern=C3=A1ndez?=
 <975883+pazos@users.noreply.github.com>
Date: Mon, 20 May 2024 18:12:54 +0200
Subject: [PATCH] Add README.md to Linux package (#11859)

---
 make/linux.mk                       |  8 ++++++++
 platform/linux/do_debian_package.sh |  2 +-
 platform/linux/instructions.txt     | 17 +++++++++++++++++
 3 files changed, 26 insertions(+), 1 deletion(-)
 create mode 100644 platform/linux/instructions.txt

diff --git a/make/linux.mk b/make/linux.mk
index 7b96e57cd..b2c614fb1 100644
--- a/make/linux.mk
+++ b/make/linux.mk
@@ -1,6 +1,8 @@
 LINUX_DIR = $(PLATFORM_DIR)/linux
 LINUX_PACKAGE:=koreader-linux-$(LINUX_ARCH_NAME)$(KODEDUG_SUFFIX)-$(VERSION).tar.xz
 
+GLIBC_VERSION := $(shell ldd --version | sed -n '1s/.* \([0-9.]\+\)$$/\1/p')
+
 update: all
 	mkdir -pv \
 		$(INSTALL_DIR)/linux/bin \
@@ -26,6 +28,12 @@ update: all
 	find $(INSTALL_DIR)/linux -type f \( -name ".git" -o -name ".gitignore" -o -name "discovery2spore" -o -name "wadl2spore" -o -name "*.txt" -o -name "LICENSE*" -o -name "NOTICE" -o -name "README.md" \) -print0 | xargs -0 rm -rf
 	find $(INSTALL_DIR)/linux -type d \( -name "test" -o -name ".github" \) -print0 | xargs -0 rm -rf
 
+	# add instructions
+	sed -e 's/%%VERSION%%/$(VERSION)/' \
+		-e 's/%%ARCH%%/$(LINUX_ARCH_NAME)/' \
+		-e 's/%%ABI%%/$(GLIBC_VERSION)/' \
+		 $(LINUX_DIR)/instructions.txt >$(INSTALL_DIR)/linux/README.md
+
 	# fix permissions
 	chmod -R u=rwX,og=rX $(INSTALL_DIR)/linux
 	XZ_OPT=9 tar -C $(INSTALL_DIR)/linux -cvJf $(LINUX_PACKAGE) .
diff --git a/platform/linux/do_debian_package.sh b/platform/linux/do_debian_package.sh
index d06e9b6a2..ea47b583f 100755
--- a/platform/linux/do_debian_package.sh
+++ b/platform/linux/do_debian_package.sh
@@ -65,7 +65,7 @@ fi
 mkdir -p tmp-debian/usr
 chmod 0755 tmp-debian/usr
 tar -xf "${1}" -C tmp-debian/usr
-rm -f tmp-debian/usr/koreader.appdata.xml
+rm -f tmp-debian/usr/koreader.appdata.xml tmp-debian/usr/README.md
 ARCH="$(echo "${1}" | cut -d '-' -f3)"
 VERSION="$(cut -f2 -dv "tmp-debian/usr/lib/koreader/git-rev" | cut -f1,2 -d-)"
 DEB_ARCH="$(uname_to_debian "${ARCH}")"
diff --git a/platform/linux/instructions.txt b/platform/linux/instructions.txt
new file mode 100644
index 000000000..7f97c405b
--- /dev/null
+++ b/platform/linux/instructions.txt
@@ -0,0 +1,17 @@
+KOReader %%VERSION%% (Linux %%ARCH%%)
+--------
+
+## Requires
+
+- `GLIBC` >= %%ABI%%
+- `SDL2`
+
+## Users
+
+#### You shouldn't use this package unless you know what you're doing. Please use [AppImage](https://github.com/koreader/koreader/wiki/Installation-on-desktop-linux#what-is-an-appimage) instead.
+
+## Package maintainers
+
+The script in **`bin/`** expects the rest of the **assets** in **`../lib/koreader`**.
+
+In any case the aforementioned script should jump to the **assets** dir and call **`./reader.lua`**.