mastorss/README.adoc

71 lines
2.0 KiB
Plaintext
Raw Normal View History

2019-12-16 01:00:59 +01:00
:toc: preamble
:project: mastorss
:uri-base: https://schlomp.space/tastytea/{project}
:uri-branch-main: {uri-base}/src/branch/main
2019-12-16 00:58:12 +01:00
:uri-gcc: https://gcc.gnu.org/
:uri-cmake: https://cmake.org/
:uri-asciidoc: http://asciidoc.org/
:uri-catch: https://github.com/catchorg/Catch2
:uri-boost: https://www.boost.org/
:uri-mastodon-cpp: https://schlomp.space/tastytea/mastodon-cpp
:uri-jsoncpp: https://github.com/open-source-parsers/jsoncpp
:uri-restclient-cpp: http://code.mrtazz.com/restclient-cpp/
2019-12-25 23:00:13 +01:00
:uri-poco: https://pocoproject.org/
2019-12-16 00:58:12 +01:00
2019-12-24 23:24:24 +01:00
*mastorss* reads RSS feeds and posts the items via the Mastodon API. Does not
support Atom at the moment.
2019-12-16 00:58:12 +01:00
== Install
=== Dependencies
* Tested OS: Linux
2019-12-25 20:10:43 +01:00
* C++ compiler (tested: link:{uri-gcc}[gcc] 8/9)
2019-12-25 02:08:16 +01:00
* link:{uri-cmake}[cmake] (at least: 3.9)
* link:{uri-boost}[boost] (at least: 1.62)
2019-12-19 15:19:48 +01:00
* link:{uri-mastodon-cpp}[mastodon-cpp] (at least: 0.111.3)
2019-12-25 23:00:13 +01:00
** link:{uri-poco}[POCO] (at least: 1.7)
2019-12-25 02:08:16 +01:00
* link:{uri-jsoncpp}[jsoncpp] (at least: 1.7)
* link:{uri-restclient-cpp}[restclient-cpp] (at least: 0.5.1)
2019-12-16 00:58:12 +01:00
=== Get sourcecode
==== Development version
[source,shell]
--------------------------------------------------------------------------------
git clone https://schlomp.space/tastytea/mastorss.git
--------------------------------------------------------------------------------
=== Compile
[source,shell]
--------------------------------------------------------------------------------
mkdir build
cd build/
cmake ..
cmake --build .
--------------------------------------------------------------------------------
Install with `make install`.
== Usage
See link:{uri-branch-main}/man/mastorss.1.adoc[manpage].
2019-12-16 00:58:12 +01:00
=== Error codes
Same as
link:{uri-mastodon-cpp}/src/branch/master/README.adoc#_error_codes[mastodon-cpp],
plus:
[%autowidth,cols=">,<"]
|===========================================================
| Code | Explanation
2019-12-16 15:23:06 +01:00
| 1 | Could not send post for unknown reasons.
2019-12-16 00:58:12 +01:00
|===========================================================
2019-12-16 01:00:59 +01:00
include::{uri-base}/raw/branch/main/CONTRIBUTING.adoc[]