Powered by OpenAIRE graph
Found an issue? Give us feedback
ZENODOarrow_drop_down
ZENODO
Presentation . 2023
License: CC BY
Data sources: Datacite
ZENODO
Presentation . 2023
License: CC BY
Data sources: Datacite
versions View all 2 versions
addClaim

This Research product is the result of merged Research products in OpenAIRE.

You have already added 0 works in your ORCID record related to the merged Research product.

How to Write a README

Authors: Maisam M. Dadkan; Garrett Speed; Beltran, Mercedes;
Abstract

Readme files are simple documentation files that can be included with data packages and are a way to convey information to yourself and others about your data packages. Documenting your data packages can help you remember where you have placed data, and how you structured data, which can be helpful when revisiting data after a vacation or a few years. In this workshop, we'll show where to find the UU Geosciences faculty README template, how to edit it, and what information to put in README files. In this workshop, we aimed to reach the following learning outcome: Where to save the README file How to create a README file What information to include in a README Learn where to download the UU Geosciences README template How to edit the UU Geosciences README template Why it is important at different research phases (with examples) Introduce different components of the README file Provide them tips and tricks to customize their README files In the presentation, we provided general information about README, its contents, and in which file format it should be created. It was shown how to use Markdown (.md) file format to write stylish README using some examples given in the MarkDown_Writing_tips file. We use an online Markdown editor to show this example. In the second part of the workshop, we showed where the participants can find the README templates of the Faculty of Geoscience and use them for their purposes. In the third part of the workshop, the participants were divided into groups. Each group received a README to review and identify what are the missing parts and give suggestions to improve each of them. Each group had up to 5 minutes to explain what they found in README. The READMEs that were used in this part are included in the README.zip file.

Related Organizations
Keywords

RDM, Data documentation, README, Data management

  • BIP!
    Impact byBIP!
    selected citations
    These citations are derived from selected sources.
    This is an alternative to the "Influence" indicator, which also reflects the overall/total impact of an article in the research community at large, based on the underlying citation network (diachronically).
    0
    popularity
    This indicator reflects the "current" impact/attention (the "hype") of an article in the research community at large, based on the underlying citation network.
    Average
    influence
    This indicator reflects the overall/total impact of an article in the research community at large, based on the underlying citation network (diachronically).
    Average
    impulse
    This indicator reflects the initial momentum of an article directly after its publication, based on the underlying citation network.
    Average
Powered by OpenAIRE graph
Found an issue? Give us feedback
selected citations
These citations are derived from selected sources.
This is an alternative to the "Influence" indicator, which also reflects the overall/total impact of an article in the research community at large, based on the underlying citation network (diachronically).
BIP!Citations provided by BIP!
popularity
This indicator reflects the "current" impact/attention (the "hype") of an article in the research community at large, based on the underlying citation network.
BIP!Popularity provided by BIP!
influence
This indicator reflects the overall/total impact of an article in the research community at large, based on the underlying citation network (diachronically).
BIP!Influence provided by BIP!
impulse
This indicator reflects the initial momentum of an article directly after its publication, based on the underlying citation network.
BIP!Impulse provided by BIP!
0
Average
Average
Average
Upload OA version
Are you the author of this publication? Upload your Open Access version to Zenodo!
It’s fast and easy, just two clicks!