Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add README.rst #4 #10

Merged
merged 33 commits into from
Aug 18, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
238ae9b
Rename README.md to README.rst #8
Ludee May 9, 2022
79386a7
Add basic structure for README.rst #8
Ludee May 9, 2022
c14d03e
Add test badge #8
Ludee May 9, 2022
117a4bf
Move badges #8
Ludee May 9, 2022
d6c6d67
Fix bar #8
Ludee May 9, 2022
3b70ab9
Remove bar #8
Ludee May 9, 2022
10e3f0e
Move badges and remove bar #8
Ludee May 9, 2022
575dedb
Fix badge target #8
Ludee May 9, 2022
e56494a
Rename LICENSE to LICENSE.txt #8
Ludee May 9, 2022
bae16f7
Fix badge link #8
Ludee May 9, 2022
e1db8af
Remove section numbering #8
Ludee May 9, 2022
837775f
Add test link collaboration #8
Ludee May 9, 2022
f70915b
Fix linebreak #8
Ludee May 9, 2022
4113fc2
"Fix license badge #8"
Ludee Jun 11, 2022
7d7e7db
Add test table for badges #8
Ludee Jun 11, 2022
aa89e9a
Add badge to table #8
Ludee Jun 11, 2022
ed5524c
Remove table title #8
Ludee Jun 11, 2022
70412bb
Add more badges #8
Ludee Jun 11, 2022
52e7891
Fix table #8
Ludee Jun 11, 2022
384e645
Test counter badge #8
Ludee Jun 11, 2022
34de59e
Fix badges #8
Ludee Jun 11, 2022
a44df8a
Fix badges #8
Ludee Jun 11, 2022
391af67
FIX now #8
Ludee Jun 11, 2022
68781f1
Add badges #8
Ludee Jun 11, 2022
c72b08b
Remove todo #8
Ludee Jun 11, 2022
03a74a3
Add issue badges #8
Ludee Jun 11, 2022
0aa8f8b
Fix badges #8
Ludee Jun 11, 2022
8e6dee2
Add text for intoduction section and add links #8
Ludee Aug 15, 2022
c6884c5
Fix typo #8
Ludee Aug 15, 2022
2143718
Update License and Citation in README #8
Ludee Aug 18, 2022
e880654
Fix link #8
Ludee Aug 18, 2022
5606c1b
Fix copyright sign #8
Ludee Aug 18, 2022
7c8c313
Solve merge conflict #8
Ludee Aug 18, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
File renamed without changes.
6 changes: 0 additions & 6 deletions README.md

This file was deleted.

77 changes: 77 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@

==========
super-repo
==========

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

.. list-table::
:widths: auto

* - License
- |badge_license|
* - Documentation
-
* - Publication
-
* - Development
- |badge_issue_open| |badge_issue_closes| |badge_pr_open| |badge_pr_closes|
* - Community
- |badge_contributing| |badge_contributors| |badge_repo_counts|

.. contents::
:depth: 2
:local:
:backlinks: top

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 <https://etherpad.wikimedia.org/p/super-repo>`_.
| The goal is to simplify and standardise the creation of software in GitHub repositories.

Documentation
=============
Documentation is in `sphinx
<http://www.sphinx-doc.org/en/stable/>`_ reStructuredText format
in the ``doc`` sub-folder of the repository.


Collaboration
=============
| Everyone is invited to develop this repository with good intentions.
| Please follow the workflow described in the `CONTRIBUTING.md <CONTRIBUTING.md>`_.

License and Citation
====================
| The code of this repository is licensed under the **MIT License** (MIT).
| See `LICENSE.txt <LICENSE.txt>`_ for rights and obligations.
| See the *Cite this repository* function or `CITATION.cff <CITATION.cff>`_ for citation of this repository.
| Copyright: `super-repo <https://github.com/rl-institut/super-repo/>`_ © `Reiner Lemoine Institut <https://reiner-lemoine-institut.de/>`_ | `MIT <LICENSE.txt>`_


.. |badge_license| image:: https://img.shields.io/github/license/rl-institut/super-repo
:target: LICENSE.txt
:alt: License

.. |badge_contributing| image:: https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat
:alt: contributions

.. |badge_repo_counts| image:: http://hits.dwyl.com/rl-institut/super-repo.svg
:alt: counter

.. |badge_contributors| image:: https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square
:alt: contributors

.. |badge_issue_open| image:: https://img.shields.io/github/issues-raw/rl-institut/super-repo
:alt: open issues

.. |badge_issue_closes| image:: https://img.shields.io/github/issues-closed-raw/rl-institut/super-repo
:alt: closes issues

.. |badge_pr_open| image:: https://img.shields.io/github/issues-pr-raw/rl-institut/super-repo
:alt: closes issues

.. |badge_pr_closes| image:: https://img.shields.io/github/issues-pr-closed-raw/rl-institut/super-repo
:alt: closes issues