Merge branch 'develop' into main
continuous-integration/drone/push Build is passing Details

This commit is contained in:
tastytea 2019-09-27 03:47:59 +02:00
commit cdb8589d3a
Signed by: tastytea
GPG Key ID: CFC39497F1B26E07
3 changed files with 26 additions and 24 deletions

View File

@ -1,4 +1,4 @@
:coc_contact: tastytea@tastytea.de :contact-coc: tastytea@tastytea.de
== Code of Conduct == Code of Conduct
@ -32,7 +32,7 @@ Examples of unacceptable behavior by participants include:
=== Enforcement === Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at {coc_contact}. reported by contacting the project team at {contact-coc}.
All complaints will be reviewed and investigated and will result in a response All complaints will be reviewed and investigated and will result in a response
that is deemed necessary and appropriate to the circumstances. The project team that is deemed necessary and appropriate to the circumstances. The project team

View File

@ -1,9 +1,13 @@
:project: remwharead :project: remwharead
:patch_contact: tastytea@tastytea.de :uri-base: https://schlomp.space/tastytea/{project}
:uri-coc: {uri-base}/src/branch/main/CODE_OF_CONDUCT.adoc
:contact-email: tastytea@tastytea.de
:contact-xmpp: {contact-email}
:contact-fediverse: https://likeable.space/users/tastytea
== How to contribute == How to contribute
Read the link:CODE_OF_CONDUCT.adoc[Code of Conduct]. Read the link:{uri-coc}[Code of Conduct].
=== Reporting bugs or suggesting enhancements === Reporting bugs or suggesting enhancements
@ -12,15 +16,14 @@ https://schlomp.space/tastytea/{project}/issues[perform a search] to see if the
problem has already been reported. If it has, add a comment to the existing problem has already been reported. If it has, add a comment to the existing
issue instead of opening a new one. Same for enhancements. issue instead of opening a new one. Same for enhancements.
You can also contact me via mailto:tastytea@tastytea.de[E-Mail], You can also contact me via mailto:{contact-email}[E-Mail],
link:xmpp:tastytea@tastytea.de[XMPP] or the link:xmpp:{contact-xmpp}[XMPP] or the {contact-fediverse}[Fediverse] if you
https://likeable.space/users/tastytea[Fediverse] if you don't want to open an don't want to open an account.
account.
=== Pull requests === Pull requests
Please use similar coding conventions as the rest of the project. The basic rule Please use similar coding conventions as the rest of the project. The basic rule
to remember is to write code in the same style as the existing/surrounding code. to remember is to write code in the same style as the existing/surrounding code.
You can also send me your patches via email, to {patch_contact} (ideally using You can also send me your patches via mailto:{contact-email}[E-Mail], ideally
`git format-patch` or `git send-email`). using `git format-patch` or `git send-email`.

View File

@ -1,12 +1,13 @@
= remwharead = remwharead
:toc: preamble :toc: preamble
:project: remwharead
:uri-base: https://schlomp.space/tastytea/{project}
:uri-branch-main: {uri-base}/src/branch/main
:uri-reference: https://doc.schlomp.space/{project}/
:uri-images-base: https://doc.schlomp.space/.{project}
:uri-archive: https://archive.org/ :uri-archive: https://archive.org/
:uri-remwharead: https://schlomp.space/tastytea/remwharead
:uri-reference: https://doc.schlomp.space/remwharead/
:uri-images-base: https://doc.schlomp.space/.remwharead
:uri-overlay: https://schlomp.space/tastytea/overlay :uri-overlay: https://schlomp.space/tastytea/overlay
:uri-remwharead: https://schlomp.space/tastytea/remwharead
:uri-blogpost: https://blog.tastytea.de/posts/keep-track-of-what-you-have-read-online-with-remwharead/ :uri-blogpost: https://blog.tastytea.de/posts/keep-track-of-what-you-have-read-online-with-remwharead/
:uri-gcc: https://gcc.gnu.org/ :uri-gcc: https://gcc.gnu.org/
:uri-clang: https://clang.llvm.org/ :uri-clang: https://clang.llvm.org/
@ -42,8 +43,8 @@ image::{uri-images-base}/example_tags.png[]
== Usage == Usage
See {uri-remwharead}/src/branch/develop/man/remwharead.1.adoc[manpage] and/or See {uri-branch-main}/man/remwharead.1.adoc[manpage] and/or read
read {uri-blogpost}[the blogpost]. {uri-blogpost}[the blogpost].
=== In your programs === In your programs
@ -68,7 +69,7 @@ emerge -a www-misc/remwharead
=== Debian and Debian based === Debian and Debian based
Download the `.deb`-package from Download the `.deb`-package from
{uri-remwharead}/releases[schlomp.space] and install {uri-base}/releases[schlomp.space] and install
with `apt install ./rewharead_*.deb`. The package works for 64 bit installations with `apt install ./rewharead_*.deb`. The package works for 64 bit installations
only. only.
@ -100,7 +101,7 @@ apt-get install g++ cmake pkg-config libpoco-dev libxdg-basedir-dev asciidoc dpk
===== Releases ===== Releases
Download the current release at {uri-remwharead}/releases[schlomp.space]. Download the current release at {uri-base}/releases[schlomp.space].
===== Development version ===== Development version
@ -138,14 +139,12 @@ generate binary packages with `make package`.
=== WebExtension === WebExtension
The {uri-remwharead}/src/branch/main/browser-plugins/webextension[WebExtension] The {uri-branch-main}/browser-plugins/webextension[WebExtension] works in
works in Firefox and possibly other browsers with WebExtension support. You can Firefox and possibly other browsers with WebExtension support. You can install
install it from {uri-ff-addon}/[addons.mozilla.org] or build it yourself with it from {uri-ff-addon}/[addons.mozilla.org] or build it yourself with
`build_xpi.sh`. `build_xpi.sh`.
== Contributing include::{uri-base}/raw/branch/main/CONTRIBUTING.adoc[]
See {uri-remwharead}/src/branch/main/CONTRIBUTING.adoc[CONTRIBUTING.adoc].
== Copyright == Copyright