gitea2rss/README.adoc
tastytea 4a40cac16b
All checks were successful
continuous-integration/drone/push Build is passing
Add hyperlink to nginx example in readme.
2020-10-24 20:36:45 +02:00

77 lines
1.8 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].
For an example nginx configuration file, see https://schlomp.space/tastytea/gitea2rss/src/branch/master/doc/nginx-example.conf[nginx-example.conf].
== 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] 8/9,
https://llvm.org/[clang] 7)
* https://cmake.org/[cmake] (at least: 3.6)
* https://curl.haxx.se/libcurl/[libcurl] (at least: 7.56)
* 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 install build-essential cmake libcurl4-openssl-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 `build/tests`. Install with `make
install`.