gitea2rss/README.adoc

86 lines
1.9 KiB
Plaintext

= gitea2rss
*gitea2rss* Generates RSS feeds from https://gitea.io[Gitea] releases or tags.
https://rss.schlomp.space/?repo=tastytea/gitea2rss[Subscribe to gitea2rss releases].
== Usage
See https://schlomp.space/tastytea/gitea2rss/src/branch/master/man/gitea2rss.1.adoc[manpage].
== Install
=== Gentoo
Add my https://schlomp.space/tastytea/overlay[repository] and install it from
there.
[source,shell]
----
eselect repository enable tastytea
echo "www-misc/gitea2rss ~amd64" >> /etc/portage/package.accept_keywords/gitea2rss
emaint sync -r tastytea
emerge -a dev-util/gitea2rss
----
=== From source
==== Dependencies
* Tested OS: Linux
* C++ compiler (tested: https://gcc.gnu.org/[gcc] 5/8/9,
https://llvm.org/[clang] 3/7)
* https://cmake.org/[cmake] (at least: 3.6)
* https://pocoproject.org/[POCO] (tested: 1.9 / 1.7)
* https://github.com/open-source-parsers/jsoncpp[jsoncpp] (tested: 1.8)
* Optional:
** Manpage: http://asciidoc.org/[asciidoc] (tested: 8.6)
===== Debian stretch
[source,shell]
----
apt-get install build-essential cmake libpoco-dev libjsoncpp-dev asciidoc
----
==== Get sourcecode
===== Releases
Download the current release at
https://schlomp.space/tastytea/gitea2rss/releases[schlomp.space].
===== Development version
[source,shell]
----
git clone https://schlomp.space/tastytea/gitea2rss.git
----
==== Compile
[source,shell]
----
mkdir build
cd build/
cmake ..
cmake --build .
----
.cmake options:
* `-DCMAKE_BUILD_TYPE=Debug` for a debug build.
* `-DWITH_MAN=NO` to not compile the manpage.
* `WITH_TESTS=YES` to compile the tests.
You can run the tests with `ctest` inside the build directory. Install with
`make install`.
== Copyright
----
Copyright © 2019 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.
----