Update README, add TODO
This commit is contained in:
parent
d596cef76a
commit
7ab7cb35fd
52
README.txt
52
README.txt
|
@ -11,10 +11,6 @@ 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
|
place any new posts into your ~/feeds/ folder, along with notifying you about
|
||||||
them.
|
them.
|
||||||
|
|
||||||
|
|
||||||
INSTALL
|
|
||||||
--------------------------------------------------
|
|
||||||
Just build it, `$ make`, and you're good.
|
|
||||||
Depends on tinyxml2.
|
Depends on tinyxml2.
|
||||||
|
|
||||||
|
|
||||||
|
@ -59,54 +55,10 @@ the source): in that case, you have two options:
|
||||||
HTTPS URL.
|
HTTPS URL.
|
||||||
|
|
||||||
|
|
||||||
USAGE
|
|
||||||
--------------------------------------------------
|
|
||||||
Usage: Pogger [-hvDus] [-m mimetype] [-tT datetime] [-cCO path]
|
|
||||||
Pogger [-hvs] [-mtTcCO] ( <text/xml file> | <META:url file> | <url> )
|
|
||||||
|
|
||||||
Pogger, a RSS and Atom feed parser/daemon.
|
|
||||||
|
|
||||||
Options:
|
|
||||||
-h, --help - Print this usage info.
|
|
||||||
-v, --verbose - Print verbose (debug) info.
|
|
||||||
-m, --mimetype - Mimetype of new item files. (Default: text/xml)
|
|
||||||
-O, --output - Output dir for item files. (Default: ~/feeds/)
|
|
||||||
-t, --before - Only return items published before this datetime.
|
|
||||||
-T, --after - Only return items published after this datetime.
|
|
||||||
-c, --config - Path to config dir. (Default: ~/config/settings/Pogger/)
|
|
||||||
-C, --cache - Path to cache. (Default: ~/config/cache/Pogger/)
|
|
||||||
-s, --save - Save the args of `-m`, `-C`, and `-O` to config.
|
|
||||||
-u, --update - Update all feeds, but don't start daemon.
|
|
||||||
-D, --foreground - Run in the foreground, do not daemonize.
|
|
||||||
`-u` and `-D` only apply when running without file/url arg.
|
|
||||||
|
|
||||||
When invoked without a file or URL, will search for any new feed items
|
|
||||||
published since last check by by any 'feed file' placed in the config
|
|
||||||
directory (default: ~/config/settings/Rifen/feeds/) and create their
|
|
||||||
corresponding files.
|
|
||||||
|
|
||||||
When invoked with a file or URL, will create files from items contained
|
|
||||||
within the given file or URL.
|
|
||||||
|
|
||||||
'Feed files' are files with a 'META:url' attribute containing the
|
|
||||||
corresponding URL to the feed's XML.
|
|
||||||
|
|
||||||
Both -t and -T use the ISO 8601 format for specifying datetimes:
|
|
||||||
YYYY-MM-DDTHH:MM:SS - 2020-01-01T07:07:07
|
|
||||||
|
|
||||||
NOTE: This message doesn't reflect reality. This is more of a spec of
|
|
||||||
what I hope this program will be. As of now, running Pogger
|
|
||||||
without a file/url free-argument is invalid, as the daemon
|
|
||||||
isn't implemented at all. As such, -D and -C are non-functional.
|
|
||||||
But it sure can turn an XML feed into files! Lol.
|
|
||||||
|
|
||||||
|
|
||||||
LIES
|
LIES
|
||||||
--------------------------------------------------
|
--------------------------------------------------
|
||||||
Pogger has no daemon yet, it can only be invoked as a standalone feed parser.
|
This README is bonkers out-of-date, and has several lies. I'll update it at some
|
||||||
Daemon-related args are ignored.
|
point soon.
|
||||||
There's no GUI yet, and no Messaging either.
|
|
||||||
Sry bby, i'm trying <3
|
|
||||||
|
|
||||||
|
|
||||||
BORING INFO
|
BORING INFO
|
||||||
|
|
|
@ -0,0 +1,30 @@
|
||||||
|
* Add subscriptions
|
||||||
|
* Feed files in ~/config/settings/Pogger/subscriptions/
|
||||||
|
* Default column layout, somehow?
|
||||||
|
* Use these Feed files as the cache files
|
||||||
|
* ~/config/cache/Pogger should be used only by random URL argvs
|
||||||
|
* Adding/editing from GUI
|
||||||
|
* Do this for file refs when Feeds, too
|
||||||
|
* Revamp configuration
|
||||||
|
* Fix saving, etc.
|
||||||
|
* Notifications
|
||||||
|
* On new entries
|
||||||
|
* Sound effect, too
|
||||||
|
* On failures
|
||||||
|
* Show progress
|
||||||
|
* With progress bar
|
||||||
|
* With indicator in the feeds list
|
||||||
|
* Timed updating
|
||||||
|
* Remove unnecessary `new`-- make sure to delete everything
|
||||||
|
* Check if arg is a file or not (treat appropriately)
|
||||||
|
* No hardcoded paths
|
||||||
|
* Show in desktray
|
||||||
|
* Make archivable
|
||||||
|
* Get menu working
|
||||||
|
* Add proper scripting support
|
||||||
|
* Multiple downloads at once?
|
||||||
|
* Array of thread_ids for multiple DL threads?
|
||||||
|
* In which case, it'd probably make sense to only spin them
|
||||||
|
up as necessary, and kill when everything's done.
|
||||||
|
* That'd require a proper queue system, instead of just
|
||||||
|
sending data to the download thread lol
|
Ŝarĝante…
Reference in New Issue