Dies ist ein Template für ein README, wie ich es in mehrerer meiner Projekte benutze.
Dies ist ein Template für ein Coq-Project, 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.
Dieses [README](README.md) bietet dafür eine Struktur, die leicht für verschiedene Projekte wiederverwendbar ist.
## Aufbau
In diesem Repository befindet sich lediglich dieses [README](README.md) sowie Informationen zum [Licensing](LICENSE).
Folgende Dateien befinden sich im Repository:
-[Makefile](Makefile): Generisches Makefile, das mit mehreren Ordnern mit Coq-Dateien umgehen kann.
-[LICENSE](LICENSE): Informationen zum Licensing.
## Installation
Dieses Projekt benötigt keine detailreiche Installationsanleitung, man kann es einfach auf [Gitlab](https://gitlab.cs.fau.de/oc59yqul/template-readme) klonen:
Dieses Projekt benötigt keine detailreiche Installationsanleitung, man kann es einfach auf [Gitlab](https://gitlab.cs.fau.de/oc59yqul/template-coq) klonen:
2. Danach mittels `git merge readmo-v*` gewünschte Version mergen.
2. Danach mittels `git merge comoproj-v*` gewünschte Version mergen.
Achtung: Tags wie z.B. `comoproj-v2.3.1` beziehen sich zumindest bezüglich der Gitlab-CI/CD immer auf die `latest`-Coq-Version.
Sollte man eine spezielle Version hierfür benötigen, stehen für einzelne Coq-Versionen bereits spezielle Versionen bereit, z.B. `comoproj-v2.3.1-coqc-v8.16.1`.
Aktuell werden für folgende Coq-Versionen konkrete Releases erstellt:
