Browse Source

Add bugtracker to readme and documentation

master
Nils 4 years ago
parent
commit
7d5d206b34
  1. 1
      template/documentation/english.adoc.template
  2. 56
      template/documentation/genlektor.py
  3. 1
      template/documentation/german.adoc.template
  4. 2
      template/documentation/readme.template

1
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..

56
template/documentation/genlektor.py

@ -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: <name>
---
year: <year>
---
version: <version>
---
logo: <shortname>.png
---
body: <description>
"""
template_lektor = template_lektor.replace("<name>", METADATA["name"])
template_lektor = template_lektor.replace("<version>", METADATA["version"])
template_lektor = template_lektor.replace("<shortname>", METADATA["shortName"])
template_lektor = template_lektor.replace("<description>", METADATA["description"])
template_lektor = template_lektor.replace("<dependencies>", METADATA["dependencies"])
template_lektor = template_lektor.replace("<author>", METADATA["author"])
template_lektor = template_lektor.replace("<year>", METADATA["year"])
print (template_lektor)

1
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.

2
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/<shortname>
# Installation and Starting

Loading…
Cancel
Save