mastorss/README.md

80 lines
2.1 KiB
Markdown
Raw Normal View History

2018-02-10 12:35:06 +01:00
**mastorss** dumps RSS feeds into a mastodon account.
2018-03-15 13:20:26 +01:00
Supports RSS 2.0 but not RSS 0.92. Does not support Atom at the moment.
2018-03-15 13:29:01 +01:00
\<item\>s in feeds must have \<link\>, \<title\> and \<description\>.
2018-03-15 13:20:26 +01:00
The documentation is far from complete, sorry.
2018-01-26 02:33:58 +01:00
# Install
## Dependencies
* Tested OS: Linux
* C++ compiler (tested: gcc 6.4, clang 5.0)
* [cmake](https://cmake.org/) (tested: 3.9.6)
* [boost](http://www.boost.org/) (tested: 1.63.0)
2018-02-10 10:01:17 +01:00
* [curlpp](http://www.curlpp.org/) (tested: 0.8.1)
* [mastodon-cpp](https://github.com/tastytea/mastodon-cpp) (at least: 0.8.6)
2018-04-14 13:57:03 +02:00
* [jsoncpp](https://github.com/open-source-parsers/jsoncpp) (tested: 1.8.4)
2018-01-26 02:33:58 +01:00
## Get sourcecode
### Development version
2018-02-10 13:48:33 +01:00
git clone https://github.com/tastytea/mastorss.git
2018-01-26 02:33:58 +01:00
## Compile
mkdir build
cd build/
cmake ..
make
2018-03-15 13:20:26 +01:00
## Install
2018-01-26 02:33:58 +01:00
Install with `make install`.
# Usage
2018-02-10 13:48:33 +01:00
Put `watchwords.json` into `~/.config/mastorss/`. Launch with profile name.
The first occurence of every watchword in an RSS item will be turned into a hashtag.
For profile-specific watchwords see the example in `watchwords.json`.
2018-01-26 20:59:01 +01:00
In the first run only the newest entry is tooted.
The profile can't be named "global".
2018-01-26 02:33:58 +01:00
## Example config file
2018-02-22 18:28:29 +01:00
${HOME}/.config/mastorss/config-example.json
{
"example": {
"instance": "botsin.space",
"feedurl": "https:\/\/example.com\/feed.rss",
"access_token": "123abc",
"max_size": "400",
2018-03-15 13:20:26 +01:00
"skip":
[
"If the entry starts with this, skip it",
"Skip me too!"
],
"fixes":
[
"delete this",
"[Rr]ead more(\.{3}|…)"
]
}
}
2018-01-26 02:33:58 +01:00
## Error codes
Same as [mastodon-cpp](https://github.com/tastytea/mastodon-cpp/blob/master/README.md#error-codes)
2018-01-26 02:33:58 +01:00
# Copyright
Copyright © 2018 tastytea <tastytea@tastytea.de>.
License GPLv3: GNU GPL version 3 <https://www.gnu.org/licenses/gpl-3.0.html>.
This program comes with ABSOLUTELY NO WARRANTY. This is free software,
and you are welcome to redistribute it under certain conditions.