From 7d5d206b34b7345605636127b1f3f947b3b30085 Mon Sep 17 00:00:00 2001 From: Nils <> Date: Sat, 11 Apr 2020 23:09:49 +0200 Subject: [PATCH] Add bugtracker to readme and documentation --- template/documentation/english.adoc.template | 1 + template/documentation/genlektor.py | 56 -------------------- template/documentation/german.adoc.template | 1 + template/documentation/readme.template | 2 + 4 files changed, 4 insertions(+), 56 deletions(-) delete mode 100644 template/documentation/genlektor.py diff --git a/template/documentation/english.adoc.template b/template/documentation/english.adoc.template index c27a6a6..5b553df 100644 --- a/template/documentation/english.adoc.template +++ b/template/documentation/english.adoc.template @@ -70,6 +70,7 @@ If you find a bug in the program (or it runs too slow) please contact us in a wa We are thankful for any help. .How to contact us +* Report bugs and issues: https://www.laborejo.org/bugs * Website: https://www.laborejo.org * E-Mail: info@laborejo.org * If you see the opportunity and know that a developer will read it also forums, social media etc.. diff --git a/template/documentation/genlektor.py b/template/documentation/genlektor.py deleted file mode 100644 index 95f2a04..0000000 --- a/template/documentation/genlektor.py +++ /dev/null @@ -1,56 +0,0 @@ -#! /usr/bin/env python3 -# -*- coding: utf-8 -*- - -""" -This documentation is licensed under Creative Commons-BY-SA-4.0. -Please read the provided documentation/LICENSE file or visit -https://creativecommons.org/licenses/by-sa/4.0/legalcode - -The documentation is built statically and does not belong to the normal build process with configure and make -Its updating is part of the development process, not packaging and running. -The correct out/ dir is already part of git. - -.adoc is asciidoctor, not simple asciidoc. -""" - - -#Make the readme - -import sys -sys.path.append("../../engine") -from config import METADATA -from subprocess import run -from os import getcwd -import os.path -assert os.path.exists(os.path.join(getcwd(), __file__)), (getcwd(), __file__) - - -#Readme - -with open("readme.template", "r") as r: - template_lektor = r.read() - -template_lektor = """ -_model: software ---- -title: ---- -year: ---- -version: ---- -logo: .png ---- -body: -""" - - -template_lektor = template_lektor.replace("", METADATA["name"]) -template_lektor = template_lektor.replace("", METADATA["version"]) -template_lektor = template_lektor.replace("", METADATA["shortName"]) -template_lektor = template_lektor.replace("", METADATA["description"]) -template_lektor = template_lektor.replace("", METADATA["dependencies"]) -template_lektor = template_lektor.replace("", METADATA["author"]) -template_lektor = template_lektor.replace("", METADATA["year"]) - -print (template_lektor) diff --git a/template/documentation/german.adoc.template b/template/documentation/german.adoc.template index 4ab6782..2ecd37f 100644 --- a/template/documentation/german.adoc.template +++ b/template/documentation/german.adoc.template @@ -71,6 +71,7 @@ Falls Sie einen Fehler im Programm entdecken (oder es zu langsam läuft) melden eine Art und Weise, die ihnen am besten passt. .Kontaktmöglichkeiten +* Bugs und Probleme melden: https://www.laborejo.org/bugs * Webseite: https://www.laborejo.org * E-Mail: info@laborejo.org * Wenn Sie die Gelegenheiten sehen und wissen, dass ein Entwickler es lesen wird sind auch Foren, Socialmedia etc. möglich. diff --git a/template/documentation/readme.template b/template/documentation/readme.template index f717dd9..6d633fd 100644 --- a/template/documentation/readme.template +++ b/template/documentation/readme.template @@ -8,6 +8,8 @@ This README is just a short introduction. Consult the manual (see below) for mor # Contact and Information * Website https://www.laborejo.org +* Bugs and Issues: https://www.laborejo.org/bugs +* Git Repositories for all programs: https://git.laborejo.org * Documentation and Manual https://www.laborejo.org/documentation/ # Installation and Starting