mastorss/README.md

65 lines
1.9 KiB
Markdown
Raw Normal View History

2018-02-10 12:35:06 +01:00
**mastorss** dumps RSS feeds into a mastodon account.
2018-02-01 12:03:16 +01:00
It is hacked together and generally only extended/fixed when it fails.
2018-02-10 13:48:33 +01:00
Do NOT assume it follows any standards.
2018-02-01 12:03:16 +01:00
Use at your own risk.
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
* [libcurl](https://curl.haxx.se/) (tested: 7.58.0)
* [curlpp](http://www.curlpp.org/) (tested: 0.8.1)
2018-02-10 14:04:43 +01:00
* [mastodon-cpp](https://github.com/tastytea/mastodon-cpp) (at least: 0.2.13)
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
cmake options:
* `-DCMAKE_BUILD_TYPE=Debug` for a debug build
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
## Error codes
| Code | Explanation |
| --------: |:------------------------------|
| 0 | No error |
| 1 | Invalid call |
| 2 | Not implemented |
| 10 | Wrong number of arguments |
2018-01-26 02:33:58 +01:00
| 100 - 999 | HTTP status codes |
| 65535 | Unknown exception |
If you use a debug build, you get more verbose error messages.
# 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.