The DORIS README template

The file README.txt is a template that you can use when submitting datasets for Researchdata.se using SND’s DORIS. The headings and lists in README.txt will help you to include relevant information. Each heading or list-item is followed by a short explanation of what information should be provided – delete the explanations and replace them with the information that is relevant for your own dataset. If a particular item is not relevant, either delete the entire item or just replace the explanatory text with “N/A”.

The README.txt template will hopefully provide you with enough structure and sufficient hints that you can use it to make a great README for your dataset without reading the accompanying document Introducing the DORIS README template.pdf! That document explains the purpose of a README file in more detail, gives more examples of what a README can contain, and has extra tips for writing README files, even for other repositories.

See SND’s information page for DORIS for more information about submitting datasets using DORIS.

New in Version 3 - DORIS now displays the reserved DOI and full recommended citation for unsubmitted datasets. The README has thus been updated to recommend that this information is included, and so the author list is no longer recommended.