Skip to content
Snippets Groups Projects
Commit 9b2b800d authored by Max Ole Elliger's avatar Max Ole Elliger :penguin:
Browse files

Merge branch 'include/readmo/v1.0.0' into 'main'

Include readmo-v1.0.0

See merge request template-coq!10
parents b00108eb 619dbd15
Branches
Tags
1 merge request!38Update .gitlab-ci.yml file
# Template README
## Beschreibung
Dies ist ein Template für ein README, wie ich es in mehrerer meiner Projekte benutze.
Deswegen steht auch oben im Titel der Name dieses Vorlagen-Projektes.
Dieses README dient einerseits als Beschreibung dieses Projektes,
andererseits aber auch als Vorlage für andere Projekte.
## Aufbau
In diesem Repository befindet sich lediglich dieses [README](README.md) sowie Informationen zum [Licensing](LICENSE).
## Installation
Dieses Projekt benötigt keine detailreiche Installationsanleitung, man kann es einfach auf [Gitlab](https://gitlab.cs.fau.de/oc59yqul/template-readme) klonen:
```
git clone git@gitlab.cs.fau.de:oc59yqul/template-readme.git
```
## Usage
Um dieses Projekt als Vorlage zu benutzen, verwende ich folgenden Workflow:
1. Dieses Template als extra Remote adden:
```
git remote add template-readme git@gitlab.cs.fau.de:oc59yqul/template-readme.git
git fetch template-readme
```
2. Danach mittels `git merge readmo-v*` gewünschte Version mergen.
## Contributing
Ich freue mich über konkrete Verbesserungsvorschläge. Diese können
- völlig unkonkret über Issues oder
- konkret über Patches oder Merge Requests
eingebracht werden. Bei Bedarf füge ich einzelne Personen auch gerne als Developer dem Repo hinzu, falls dies den Workflow erleichtert.
## Kontakt
Ich bin u.A. per [E-Mail](ole.elliger@fau.de) erreichbar.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment