63 lines
1.6 KiB
Plaintext
63 lines
1.6 KiB
Plaintext
MinRSS
|
|
======
|
|
MinRSS is an RSS/Atom feed reader for Linux inspired by suckless.org's
|
|
IRC clients ii and sic. Instead of presenting articles as entries
|
|
in a menu, it saves them as files in folders.
|
|
|
|
rss
|
|
|--news
|
|
| |--article1
|
|
| `--article2
|
|
`--blog
|
|
|--post
|
|
`--other_post
|
|
|
|
Requirements
|
|
------------
|
|
You need libcurl and libxml2 to compile MinRSS.
|
|
|
|
Installation
|
|
------------
|
|
Run this command to build MinRSS:
|
|
|
|
make clean install
|
|
|
|
This will install the binary to ~/.local/bin. Make sure that this directory is
|
|
in your $PATH.
|
|
|
|
If you need to change this, set the PREFIX variable in Makefile.
|
|
|
|
Configuration
|
|
-------------
|
|
MinRSS is configured via the config.h file, which you can create by
|
|
either compiling MinRSS for the first time or copying config.def.h
|
|
to it. To save your changes, recompile MinRSS.
|
|
|
|
You are required to input a list of URLs in config.h before compilation
|
|
in order to successfully run MinRSS.
|
|
|
|
|
|
static const linkStruct links[] = {
|
|
{
|
|
.url = "https://example.com/rss/",
|
|
.feedName = "example-feed",
|
|
},
|
|
};
|
|
|
|
|
|
Using MinRSS
|
|
------------
|
|
Make a directory to store your RSS feeds, then cd into it. Then, enter
|
|
the minrss command to download the RSS feeds. Your feeds will be
|
|
available as folders in your current working directory.
|
|
|
|
Compatibility
|
|
-------------
|
|
This program is designed to work on Linux, but it should be possible
|
|
to make it run on other operating systems. If you can do that
|
|
successfully, please contact me about it.
|
|
|
|
Note that if you use MinRSS on different systems, it will be possible for
|
|
attackers to write malicious filenames, so you should rewrite sanitize()
|
|
accordingly.
|