From 5c09b3c2adff3434b19e78bb7f2d8af698fde26b Mon Sep 17 00:00:00 2001
From: yctct <yctct@yctct.com>
Date: Wed, 5 Nov 2025 12:35:30 +0100
Subject: Add files

---
 README.txt | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)
 create mode 100644 README.txt

(limited to 'README.txt')

diff --git a/README.txt b/README.txt
new file mode 100644
index 0000000..5c94d7f
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,28 @@
+This is a script to save an article from Newsboat RSS reader to an epub file.
+
+Setup
+------
+
+- copy the script into a file in ~/bin
+- make sure that ~/bin is included in $PATH ($ echo $PATH)
+- make the script executable by running 
+
+	$ chmod u+x script.sh
+
+- modify the path to the directory where you'd like epub files to be saved -- see comment in script
+- add these two lines to newsboat's config file, probably located at ~/.newsboat/config
+
+	# Save article .epub
+	macro S pipe-to "~/bin/save-article-to-epub.py" 
+
+Usage
+------
+
+- in Newsboat, when you want to save an article, press , then shift + S.
+
+License
+-------
+
+GPLv3
+
+Script originally written by Ludivico Gerardi.
-- 
cgit v1.2.3