Skip to content

Latest commit

 

History

History
131 lines (102 loc) · 5.58 KB

README.rst

File metadata and controls

131 lines (102 loc) · 5.58 KB
Repo logo

super-repo

A template repo to test and document elements and features for research software.

License License REUSE
Documentation Documentation Documentation Codecov
Publication PyPI Version PyPI Python Version PyPI Downloads
Development open issues closes issues closes issues closes issues
Community contributions contributors counter (daily / total) Matrix

Introduction

A template repo to test and document elements and features for research software.
It implements the collection of repository elements collected in this Etherpad.
The goal is to simplify and standardize the creation of software in GitHub repositories.

Documentation

The documentation is created with Markdown using MkDocs and mike.
All files are stored in the docs folder of the repository.
A GitHub Actions deploys the develop branch on a GitHub Page.
The documentation page is: rl-institut.github.io/super-repo/

Collaboration

Everyone is invited to develop this repository with good intentions.
Please follow the workflow described in the CONTRIBUTING.md.

Contributors:

[contrib.rocks](https://contrib.rocks)

License and Citation

The code of this repository is licensed under the MIT License (MIT).
See LICENSE.txt for rights and obligations.
See the Cite this repository function or CITATION.cff for citation of this repository.