From bb67d09f032a5467a070d07851f00db5115321e9 Mon Sep 17 00:00:00 2001 From: tastytea Date: Fri, 27 Sep 2019 03:19:04 +0200 Subject: [PATCH 1/4] Make more use of variables in readme. --- README.adoc | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/README.adoc b/README.adoc index e1891f6..b1f1be4 100644 --- a/README.adoc +++ b/README.adoc @@ -1,12 +1,13 @@ = remwharead :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-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-remwharead: https://schlomp.space/tastytea/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-clang: https://clang.llvm.org/ @@ -42,8 +43,8 @@ image::{uri-images-base}/example_tags.png[] == Usage -See {uri-remwharead}/src/branch/develop/man/remwharead.1.adoc[manpage] and/or -read {uri-blogpost}[the blogpost]. +See {uri-branch-main}/man/remwharead.1.adoc[manpage] and/or read +{uri-blogpost}[the blogpost]. === In your programs @@ -68,7 +69,7 @@ emerge -a www-misc/remwharead === Debian and Debian based 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 only. @@ -100,7 +101,7 @@ apt-get install g++ cmake pkg-config libpoco-dev libxdg-basedir-dev asciidoc dpk ===== Releases -Download the current release at {uri-remwharead}/releases[schlomp.space]. +Download the current release at {uri-base}/releases[schlomp.space]. ===== Development version @@ -138,9 +139,9 @@ generate binary packages with `make package`. === WebExtension -The {uri-remwharead}/src/branch/main/browser-plugins/webextension[WebExtension] -works in Firefox and possibly other browsers with WebExtension support. You can -install it from {uri-ff-addon}/[addons.mozilla.org] or build it yourself with +The {uri-branch-main}/browser-plugins/webextension[WebExtension] works in +Firefox and possibly other browsers with WebExtension support. You can install +it from {uri-ff-addon}/[addons.mozilla.org] or build it yourself with `build_xpi.sh`. == Contributing From 8d2cb99e0c9a08005a305feb18bb52e571b85dce Mon Sep 17 00:00:00 2001 From: tastytea Date: Fri, 27 Sep 2019 03:19:31 +0200 Subject: [PATCH 2/4] Include contributions guidelines in readme. --- README.adoc | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/README.adoc b/README.adoc index b1f1be4..0442216 100644 --- a/README.adoc +++ b/README.adoc @@ -144,9 +144,7 @@ Firefox and possibly other browsers with WebExtension support. You can install it from {uri-ff-addon}/[addons.mozilla.org] or build it yourself with `build_xpi.sh`. -== Contributing - -See {uri-remwharead}/src/branch/main/CONTRIBUTING.adoc[CONTRIBUTING.adoc]. +include::{uri-base}/raw/branch/main/CONTRIBUTING.adoc[] == Copyright From 5e5ce2e31eeb049deb282a5c20c47c0dc5856179 Mon Sep 17 00:00:00 2001 From: tastytea Date: Fri, 27 Sep 2019 03:20:35 +0200 Subject: [PATCH 3/4] use more variables in contribution guidelines. --- CONTRIBUTING.adoc | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.adoc b/CONTRIBUTING.adoc index d075d5a..9a9471b 100644 --- a/CONTRIBUTING.adoc +++ b/CONTRIBUTING.adoc @@ -1,9 +1,13 @@ :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 -Read the link:CODE_OF_CONDUCT.adoc[Code of Conduct]. +Read the link:{uri-coc}[Code of Conduct]. === 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 issue instead of opening a new one. Same for enhancements. -You can also contact me via mailto:tastytea@tastytea.de[E-Mail], -link:xmpp:tastytea@tastytea.de[XMPP] or the -https://likeable.space/users/tastytea[Fediverse] if you don't want to open an -account. +You can also contact me via mailto:{contact-email}[E-Mail], +link:xmpp:{contact-xmpp}[XMPP] or the {contact-fediverse}[Fediverse] if you +don't want to open an account. === Pull requests 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. -You can also send me your patches via email, to {patch_contact} (ideally using -`git format-patch` or `git send-email`). +You can also send me your patches via mailto:{contact-email}[E-Mail], ideally +using `git format-patch` or `git send-email`. From a5c21f4109fe66b1b613991a9659fd5629b36edc Mon Sep 17 00:00:00 2001 From: tastytea Date: Fri, 27 Sep 2019 03:25:19 +0200 Subject: [PATCH 4/4] Fix contact-variable in COC. --- CODE_OF_CONDUCT.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CODE_OF_CONDUCT.adoc b/CODE_OF_CONDUCT.adoc index 227e1d2..a561593 100644 --- a/CODE_OF_CONDUCT.adoc +++ b/CODE_OF_CONDUCT.adoc @@ -1,4 +1,4 @@ -:coc_contact: tastytea@tastytea.de +:contact-coc: tastytea@tastytea.de == Code of Conduct @@ -32,7 +32,7 @@ Examples of unacceptable behavior by participants include: === Enforcement 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 that is deemed necessary and appropriate to the circumstances. The project team