mastorss/README.adoc

= 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-libcurl: https://curl.haxx.se/libcurl/

*mastorss* reads RSS feeds and posts the items via the Mastodon API. Does not
support Atom at the moment.

== Usage

See link:{uri-branch-main}/man/mastorss.1.adoc[manpage].

== Install

[alt="Packaging status" link=https://repology.org/project/mastorss/versions]
image::https://repology.org/badge/vertical-allrepos/mastorss.svg[]

=== Gentoo

[source,shell]
--------------------------------------------------------------------------------
eselect repository enable guru
echo 'net-misc/mastorss' >> /etc/portage/package.accept_keywords/mastorss
emaint sync -r guru
emerge -a net-misc/mastorss
--------------------------------------------------------------------------------

=== Arch

The git-version is available via the AUR:
<https://aur.archlinux.org/packages/mastorss-git/>.

=== From source

==== 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.5.6)
* link:{uri-jsoncpp}[jsoncpp] (at least: 1.7)
* link:{uri-libcurl}[libcurl] (at least: 7.52)

==== 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:
* `-DCMAKE_BUILD_TYPE=Debug` Debug build.
* `-DWITH_MAN=NO` Don't install manpage.
* `-DWITH_COMPLETIONS=NO` Don't install completions.
* `-DZSH_COMPLETION_DIR` Change installation directory for Zsh completions.

Install with `make install`.

include::{uri-base}/raw/branch/main/CONTRIBUTING.adoc[]