69 lines
2.0 KiB
Plaintext
69 lines
2.0 KiB
Plaintext
= mastorss
|
|
:toc: preamble
|
|
|
|
:project: mastorss
|
|
:uri-base: https://schlomp.space/tastytea/{project}
|
|
:uri-branch-main: {uri-base}/src/branch/main
|
|
: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-mastodonpp: https://schlomp.space/tastytea/mastodonpp
|
|
:uri-jsoncpp: https://github.com/open-source-parsers/jsoncpp
|
|
:uri-restclient-cpp: http://code.mrtazz.com/restclient-cpp/
|
|
|
|
*mastorss* reads RSS feeds and posts the items via the Mastodon API. Does not
|
|
support Atom at the moment.
|
|
|
|
[IMPORTANT]
|
|
The branch `master` has been renamed to `main`. If you have cloned this repo
|
|
before 2019-12-28, please update your git settings accordingly.
|
|
|
|
== Install
|
|
|
|
=== Dependencies
|
|
|
|
* Tested OS: Linux
|
|
* C++ compiler (tested: link:{uri-gcc}[gcc] 7/8/9)
|
|
* link:{uri-cmake}[cmake] (at least: 3.9)
|
|
* link:{uri-boost}[boost] (at least: 1.62)
|
|
* link:{uri-mastodonpp}[mastodonpp] (at least: 0.4)
|
|
* link:{uri-jsoncpp}[jsoncpp] (at least: 1.7)
|
|
* link:{uri-restclient-cpp}[restclient-cpp] (at least: 0.5.1)
|
|
|
|
=== Get sourcecode
|
|
|
|
==== Release
|
|
|
|
Download the current release at link:{uri-base}/releases[schlomp.space].
|
|
|
|
==== Development version
|
|
|
|
[source,shell]
|
|
--------------------------------------------------------------------------------
|
|
git clone https://schlomp.space/tastytea/mastorss.git
|
|
--------------------------------------------------------------------------------
|
|
|
|
=== Compile
|
|
|
|
[source,shell]
|
|
--------------------------------------------------------------------------------
|
|
mkdir build
|
|
cd build/
|
|
cmake ..
|
|
cmake --build .
|
|
--------------------------------------------------------------------------------
|
|
|
|
.CMake options:
|
|
* `-DWITH_MAN=NO` to not compile the manpage (default is `YES`).
|
|
* `-DWITH_DESKTOP=YES` to build the .desktop file (default is `NO`).
|
|
|
|
Install with `make install`.
|
|
|
|
== Usage
|
|
|
|
See link:{uri-branch-main}/man/mastorss.1.adoc[manpage].
|
|
|
|
include::{uri-base}/raw/branch/main/CONTRIBUTING.adoc[]
|