repository-template/src/generic/README.md.jinja at main · sdsc-ordes/repository-template · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
<p align="center">
  <img src="./docs/assets/logo.svg" alt="project logo" width="250">
</p>

<h1 align="center">
  {{ project_name | slug }}
</h1>
<p align="center">
</p>

{% for host in project_hosts[0:1] %}
{%- if "github" in host.host %}
[![Current Release](https://img.shields.io/github/release/{{ host.organization }}/{{ host.repo }}.svg?label=release)](https://{{ host.host }}/{{ host.organization }}/{{ host.repo }}/releases/latest)
[![Pipeline Status](https://img.shields.io/github/actions/workflow/status/{{ host.organization }}/{{ host.repo }}/normal.yaml?label=ci)](https://{{ host.host }}/{{ host.organization }}/{{ host.repo }}/actions/workflows/normal.yaml)
{%- elif "gitlab" in host.host %}
[![Current Release](https://{{ host.host }}/{{ host.organization }}/{{ host.repo }}/-/badges/release.svg)](https://{{ host.host }}/{{ host.organization }}/{{ host.repo }}/-/releases)
[![Pipeline Status](https://{{ host.host }}/{{ host.organization }}/{{ host.repo }}/badges/main/pipeline.svg)](https://{{ host.host }}/{{ host.organization }}/{{ host.repo }}/-/pipelines)
{%- endif %}
{%- endfor %}

{%- if project_license == "mit" %}
[![License label](https://img.shields.io/badge/License-MIT-blue.svg?)](https://mit-license.org/)
{%- elif project_license == "apache2" %}
[![License label](https://img.shields.io/badge/License-Apache2.0-blue.svg?)](http://www.apache.org/licenses/LICENSE-2.0.html)
{%- endif %}

{%- if project_language == "go" %}
{%- for host in project_hosts[0:1] %}
[![Go Doc](https://pkg.go.dev/badge/{{ host.host }}/{{ host.organization }}/{{ host.repo }})](https://pkg.go.dev/{{ host.host }}/{{ host.organization }}/{{ host.repo }})
[![Go Report Card](https://goreportcard.com/badge/{{ host.host }}/{{ host.organization }}/{{ host.repo }})](https://goreportcard.com/report/{{ host.host }}/{{ host.organization }}/{{ host.repo }})
{%- endfor %}
{%- endif %}

**Authors:**

{% for m in project_authors -%}
- [{{ m.first_name }} {{m.last_name}}](mailto:{{m.email}})
{% endfor %}

## Installation

Describe the installation instruction here.

## Usage

Describe the installation instruction here.

## Development

Read first the [Contribution Guidelines](/CONTRIBUTING.md).

For technical documentation on setup and development, see the
[Development Guide](docs/development-guide.md)

## Acknowledgement

Acknowledge all contributors and external collaborators here.

## Copyright

{% if project_hosts[0].organization.lower() == "swissdatasciencecenter" or project_hosts[0].organization.lower() == "sdsc-ordes" -%}
Copyright © {% now 'utc', '%Y' %}-2028 Swiss Data Science Center (SDSC),
[www.datascience.ch](http://www.datascience.ch/). All rights reserved. The SDSC
is jointly established and legally represented by the École Polytechnique
Fédérale de Lausanne (EPFL) and the Eidgenössische Technische Hochschule Zürich
(ETH Zürich). This copyright encompasses all materials, software, documentation,
and other content created and developed by the SDSC.
{%- else %}
Add here your copyright statement.
{%- endif %}