~ A terminal news feed reader with a fancy ui ~
Developed by @veeso
Current version: 0.1.0 (FIXME:/10/2021)
tuifeed is a news feed reader with a fancy terminal user interface. It allows you read news from your favourite RSS and Atom sources, which can be easily configured in a TOML file.
⚠️ I'M STILL WORKING ON IT, DON'T DOWNLOAD IT YET
Install with cargo
cargo install tuifeedIn order to start using tuifeed, the first thing you need to do is to configure the feeds you want to read from.
To open the configuration file you can run
tuifeed -cthis will open the configuration file in your favourite editor.
❗ If you don't have a GUI you can edit your configuration file at:
~/.config/tuifeed/config.tomlon Linux/Users/$USER/Library/Application\ Support/tuifeed/config.tomlon MacOS
then you can add new sources as follows:
[sources]
Il_Post_Mondo = "https://www.ilpost.it/mondo/feed/"
Il_Post_Italia = "https://www.ilpost.it/italia/feed/"
New_York_Times = "https://rss.nytimes.com/services/xml/rss/nyt/World.xml"so for each feed you want to read from, you must put an entry with a key, which identifies the Name of the source as it'll be displayed in the UI associated to the URL of the feed.
🪄 If you want to use special characters in toml you can quote the key name:
"Il Post (Mondo)" = "https://www.ilpost.it/mondo/feed/"
Once you're done with configuration, save, close and enjoy tuifeed 😄
TBD
If you like tuifeed and you're grateful for the work I've done, please consider a little donation 🥳
You can make a donation with one of these platforms:
Contributions, bug reports, new features and questions are welcome! 😉 If you have any question or concern, or you want to suggest a new feature, or you want just want to improve tuifeed, feel free to open an issue or a PR.
TODO: contributing Please follow our contributing guidelines
View tuifeed's changelog HERE
tuifeed is licensed under the MIT license.
You can read the entire license HERE