Delete the text in this section after reding it when using this template. Text between []
provides short descriptions of what is expected in each section, and should be deleted after after you write your own.
Purpose
This repository provides a template to make your software project more compliant with the FAIR principles. It adopts the recommendations made by the TU Delft Guidelines on Research Software.
How to use this template
How to organize source code
[The organization of your source code depends on the progamming language and the purpose of the code. However, here are some general recommendations:
repo-template
directory.Important: when using this template, keep the stucture suggested in
repo-template
, but change the name to match you repository's name.
Delete this text above when using this template in your repository
[Repository Description: In two or three sentences, describe the purpose of the repository: what is this repository for?]
[Describe the steps that users (not developers) should follow to install the code in each of the intended platforms (e.g. Window 10, MacOS, etc.).]
Requirements
[List and describe each step required to install the software. Use a description/example format. For example:]
[1. Install dependencies ]
[$ pip install -r requirements.txt]
Read the contributing guidelines to know how can you take part in this project.
[ Include a CONTRIBUTING.md
files ]
[Under the current guidelines on research software, TU Delft encourages the use of open source licenses for research software. Use the decision three below to determine if the software you intend to develop can be published as Open Source Software (OSS). You can also ask for help to the Data Steward in your Faculty]
[If using an open source license, select one of the followings pre-approved licences:]
[TU Delft owns the copyrights of any software developed by TU Delft researchers. However, if the software is published as OSS, TU Delft agrees to transfer such rights to the Author(s) of the software. If using an OSS license, you can claim the copyright by using the following text:]
© (YEAR) [Author(s)], Delft, The Netherlands.
[Include a CCF file (Citation File Format). See example in this repo: CITATION.cff
. You can easily create the content of a CCF using this tool. ]
[CCF files can be converted to a multitude of formats, including BibTex, EndNote, codemeta, plain JSON, schema.org, RIS, and Zenodo JSON ]
[Name anyone who deserves it.]