diff --git a/CMakeLists.txt b/CMakeLists.txt index 2a342ff..20c72b8 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -6,7 +6,7 @@ option(WITH_SANITIZERS "Use sanitizers in debug builds." NO) project(highlight-diffpatch VERSION 0.1.0 - DESCRIPTION "highlight diff-ed patches" + DESCRIPTION "Highlight diff-ed patches" HOMEPAGE_URL "https://schlomp.space/tastytea/highlight-diffpatch" LANGUAGES CXX) diff --git a/CODE_OF_CONDUCT.adoc b/CODE_OF_CONDUCT.adoc new file mode 100644 index 0000000..7a5d03c --- /dev/null +++ b/CODE_OF_CONDUCT.adoc @@ -0,0 +1,49 @@ +:contact-coc: tastytea@tastytea.de +:uri-coc-original: https://www.contributor-covenant.org/version/1/4/code-of-conduct.html + +== Code of Conduct + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, education, ethnicity, gender identity and expression, level of +experience, nationality, personal appearance, race, religion, sex +characteristics, sexual identity and orientation or socio-economic status. + +=== Examples + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language. +* Being respectful of differing viewpoints and experiences. +* Gracefully accepting constructive criticism. +* Focusing on what is best for the community. +* Showing empathy towards other community members. + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or + advances. +* Trolling, insulting/derogatory comments, and personal attacks. +* Public or private harassment. +* Publishing others’ private information, such as a physical or electronic + address, without explicit permission. + +=== Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +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 +is obligated to maintain confidentiality with regard to the reporter of an +incident. + +=== Attribution + +This Code of Conduct is adapted from the link:{uri-coc-original}[Contributor +Covenant, version 1.4]. + +For answers to common questions about this code of conduct, see +link:https://www.contributor-covenant.org/faq[]. diff --git a/CONTRIBUTING.adoc b/CONTRIBUTING.adoc new file mode 100644 index 0000000..0258c4b --- /dev/null +++ b/CONTRIBUTING.adoc @@ -0,0 +1,70 @@ +:project: highlight-diffpatch +:uri-base: https://schlomp.space/tastytea/{project} +:uri-branch-main: {uri-base}/src/branch/main +:uri-coc: {uri-branch-main}/CODE_OF_CONDUCT.adoc +:contact-email: tastytea@tastytea.de +:uri-git-format-patch: https://git-scm.com/docs/git-format-patch +:uri-git-send-email: https://git-scm.com/docs/git-send-email +:uri-poedit: https://poedit.net/ + +== How to contribute + +Read the link:{uri-coc}[Code of Conduct]. + +=== Reporting bugs or suggesting enhancements + +Before reporting a bug, please +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:{contact-email}[E-Mail] 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. + +Add a copyright line with the year, your name and your email address to the +files you edited. Add your name and email to +link:{uri-branch-main}/AUTHORS[AUTHORS]. Unless you don't want to. + +You can also send me your patches via mailto:{contact-email}[E-Mail], ideally +using link:{uri-git-send-email}[git send-email]. + +// === Translations + +// ==== Creating a new translation + +// To create a new translation, copy `translations/{project}.pot` to +// `translations/[LANGUAGE ABBREVIATION].po` (Replace [LANGUAGE ABBREVIATION] with +// the correct abbreviation for your language, e.g. “es” if you are translating +// into Spanish or “pt_BR” if you are translating into Brazilian Portuguese). The +// pot-file is generated during the build process. + +// Open your new po file with your favourite text editor, (or you may prefer to use +// a translation catalog editor like link:{uri-poedit}[Poedit]), and first edit the +// header section of your file. You will need to replace the text in UPPERCASE with +// the correct values. The easiest way to work out how to do this is to compare it +// to another po file that already exists. + +// ==== Updating your translation + +// When it is time to update your translation, first update your Git working +// directory. Then do the following: + +// [source,shell] +// -------------------------------------------------------------------------------- +// cmake --build build +// cd translations +// msgmerge --update es.po mlmmj-submod-webgui.pot +// -------------------------------------------------------------------------------- + +// Then open your file and locate the strings that need updating. These will have +// an empty *msgstr* or will be marked “fuzzy”. + +// _The translation guide is based on +// , licensed +// under GFDL-1.2-only._ diff --git a/README.adoc b/README.adoc new file mode 100644 index 0000000..c079265 --- /dev/null +++ b/README.adoc @@ -0,0 +1,29 @@ += highlight-diffpatch +:showtitle: +:project: highlight-diffpatch +:uri-base: https://schlomp.space/tastytea/{project} +:uri-branch-main: {uri-base}/src/branch/main +:uri-license: {uri-branch-main}/LICENSE +:uri-man: {uri-branch-main}/man/{project}.1.adoc + +*highlight-diffpatch* highlights diff-ed patches. It is licensed under the + link:{uri-license}[AGPL-3.0-only]. + +== Usage + +[source,] +-------------------------------------------------------------------------------- +git show --color=always HEAD | highlight-diffpatch +git config --global core.pager "diff-highlight | highlight-diffpatch | less --tabs=4 -RFX" +-------------------------------------------------------------------------------- + +== Install + +[source,shell] +-------------------------------------------------------------------------------- +cmake -S . -B build +cmake --build build --parallel +sudo cmake --install build +-------------------------------------------------------------------------------- + +include::{uri-base}/raw/branch/main/CONTRIBUTING.adoc[]