New README file

This commit is contained in:
Jaidyn Ann 2021-03-21 13:01:23 -05:00
parent aaeb59df1d
commit 440b39d771
3 changed files with 36 additions and 70 deletions

36
README.md Normal file
View File

@ -0,0 +1,36 @@
# Pogger
A simple RSS/Atom feed aggregator for Haiku.
![The Main Window](img/screenshots/mainWindow.png)
![Feed entries in Tracker](img/screenshots/feedEntries.png)
Pogger works vaguely similarly to the mail service― you configure it, add your subscriptions, and forget about it. New entries for your feeds will be dumped into your feeds folder.
It works best for news or blog feeds, podcasts and the sort work better on [BePodder](https://github.com/HaikuArchives/BePodder).
## Usage
Whenever a subscribed feed is updated, "feed entry" files are dumped into your feeds folder, /boot/home/feeds/ by default. They have the attributes you might expect― URL of the entry, the title, source, time posted, etc. The file contains the contents of that entry, if any were provided.
It's recommended to use Pogger to open these files, instead of directly using a web-browser. This'll smooth out any incompatibilities and make sure entries are opened just how you like them― as the downloaded HTML, or as a URL.
By default, it will open entries as URLs with WebPositive.
### Feeds
In the "Feeds" tab you can manage your subscribed feeds, and see the progress of the current update. Feeds that failed to update are marked with an "X" in their row.
### Entries
In "Entries" you can change your feed folder and how Pogger will handle the opening of feed entries.
### Updates
In "Updates" you can toggle notifications and set the frequency of updates.
## Building
`$ make`
Uses netservices, and has TinyXML2 as a dependency.
## License
This project is under the MIT license.

View File

@ -1,68 +0,0 @@
POGGER feed parser/daemon
===============================================================================
Pogger is an Atom/RSS feed parser and daemon, intending to be a sorta-clone of
the Haiku mail daemon.
It can be run as a daemon, or as a simple XML feed parser for turning a feed's
URL or file into a set of post-files, with appropriate metadata attributes.
When run as a daemon, it'll check your configured feeds periodically, and
place any new posts into your ~/feeds/ folder, along with notifying you about
them.
Depends on tinyxml2.
CONFIGURATION
--------------------------------------------------
To add feeds to Pogger, create HTTPS URL files as a link to the RSS/Atom feed
(as long as the attribute META:url is used you're good), and put them in
`~/config/settings/Pogger/feeds/`.
To configure defaults (i.e., mimetype, output dir, etc), use the `-s` option
when invoking Pogger.
POST FILES
--------------------------------------------------
Each feed's post is represented as a file (much like the mail daemon does with
e-mails), with the following attributes:
Int-32 unixDate - contains the date in epoch time
Text date - Publication/update datetime for the post
Text META:title - Post-title, ofc
Text description - Description/summary of post
Text META:url - URL of the post
Text BEOS:TYPE - Defaults to text/xml, but you can config
The file's content will be the <content> attribute from RSS, or the
from Atom. If there's no content, then the file will be empty.
Since the default mimetype is text/xml, the default behavior of Tracker is
to open post files in a web-browser, reading them as HTML.
However, you might find it more useful to open post's URLs rather than HTML
content (many don't have content whatsoever, or you might prefer to read from
the source): in that case, you have two options:
* setting the default mimetype to `application/x-vnd.Be.Url.https`
(HTTPS URL), so that your web-browser will open the URL rather than
file-content
* enable auto-mimetype; this will automatically set the type to HTTPS
URL
you don't specify a default mimetype. It will set all posts to
text/xml unless they lack content, in which case they will be an
HTTPS URL.
LIES
--------------------------------------------------
This README is bonkers out-of-date, and has several lies. I'll update it at some
point soon.
BORING INFO
--------------------------------------------------
Pogger is under the MIT license.
https://github.com/JadedCtrl/Pogger
jadedctrl@teknik.io

View File

@ -1,5 +1,4 @@
Important Features:
* Default column layouts for ~/feeds and ~/config/settings/Pogger/Subscriptions
* Localization
@ -8,7 +7,6 @@ Important improvements:
* ~.05MB per feed on download, in Util.ccp, fetch(). I'm stumped here.
* ~.02MB per feed on parsing
* Fix background of Feeds List error status icon (it's black, not transparent)
* Make fancy Markdown README
* Make an icon(idk I'm not an artist)