gitea2rss/README.adoc

77 lines
1.8 KiB
Plaintext
Raw Normal View History

2019-04-17 00:17:26 +02:00
= gitea2rss
2019-04-20 07:43:23 +02:00
*gitea2rss* Generates RSS feeds from https://gitea.io[Gitea] releases or tags.
2019-04-17 04:36:16 +02:00
2019-04-17 18:52:51 +02:00
https://rss.schlomp.space/?repo=tastytea/gitea2rss[Subscribe to gitea2rss releases].
2019-04-17 05:07:56 +02:00
2019-04-17 04:36:16 +02:00
== Usage
2019-08-09 23:07:45 +02:00
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].
2019-04-17 04:36:16 +02:00
== Install
=== Gentoo
Add my https://schlomp.space/tastytea/overlay[repository] and install it from
there.
2019-08-09 22:38:28 +02:00
[source,shell]
2019-04-17 04:36:16 +02:00
----
eselect repository enable tastytea
2019-05-18 02:10:49 +02:00
echo "www-misc/gitea2rss ~amd64" >> /etc/portage/package.accept_keywords/gitea2rss
2019-04-17 04:36:16 +02:00
emaint sync -r tastytea
emerge -a dev-util/gitea2rss
----
=== From source
==== Dependencies
* Tested OS: Linux
2020-10-24 17:14:18 +02:00
* C++ compiler (tested: https://gcc.gnu.org/[gcc] 8/9,
https://llvm.org/[clang] 7)
2019-04-17 04:36:16 +02:00
* https://cmake.org/[cmake] (at least: 3.6)
2020-10-24 16:59:41 +02:00
* https://curl.haxx.se/libcurl/[libcurl] (at least: 7.56)
2019-04-17 04:36:16 +02:00
* https://github.com/open-source-parsers/jsoncpp[jsoncpp] (tested: 1.8)
2019-04-17 07:27:05 +02:00
* Optional:
** Manpage: http://asciidoc.org/[asciidoc] (tested: 8.6)
2019-04-17 04:36:16 +02:00
===== Debian stretch
2019-08-09 22:38:28 +02:00
[source,shell]
----
2020-10-24 18:35:04 +02:00
apt install build-essential cmake libcurl4-openssl-dev libjsoncpp-dev asciidoc
----
2019-04-17 04:36:16 +02:00
==== Get sourcecode
===== Releases
Download the current release at
https://schlomp.space/tastytea/gitea2rss/releases[schlomp.space].
===== Development version
2019-08-09 22:38:28 +02:00
[source,shell]
2019-04-17 04:36:16 +02:00
----
git clone https://schlomp.space/tastytea/gitea2rss.git
----
==== Compile
2019-08-09 22:38:28 +02:00
[source,shell]
2019-04-17 04:36:16 +02:00
----
2020-10-24 18:35:04 +02:00
mkdir build && cd build
2019-04-17 04:36:16 +02:00
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.
2019-04-17 04:36:16 +02:00
2020-10-24 18:35:04 +02:00
You can run the tests with `ctest` inside `build/tests`. Install with `make
install`.