super-repo

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

License
Documentation
Tests
Publication
Development
Community

• Introduction
• Documentation
• Collaboration
• License and Citation

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:

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.

Copyright: super-repo © Reiner Lemoine Institut | MIT