This repository contains templates for repository readme (readme.md) files. There are a few templates to choose from for now there are two options: minimal and detailed.

• Minimal is better for internal use and contains minimal and straight-forward guidelines how to use the code in the repo
• Detailed is better for public repos where you give visitors more information about the tool, research context etc.

The templates are here to help DGL researches publish their code/scripts on GitHub and to harmonize the readme structure across the repositories.

You select the file you want (detailed or minimal), click on the pencil logo in the upper right corner after selection, copy paste the raw text to your own GitHub repository's readme.md file. Then replace the filler texts with your own proper text.