Skip to content

Commit

Permalink
Fix error in documentation.qmd
Browse files Browse the repository at this point in the history
  • Loading branch information
NeuroShepherd committed Sep 3, 2024
1 parent d1de53d commit 16d1440
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion documentation.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ Machine-readability refers to the ability of machines (computers, algorithms, et

We already established that metadata and README files are strongly connected. They form a great way to provide an introduction to and documentation of a dataset and its research context. A README file is a plain text file often written in markdown and then named "README.md". This naming convention helps spotting the README file for humans and machines alike, e.g. in GitHub repositories the README.md file is identified automatically and its content displayed on the repositories main page. The README file should be one of the first files your create for a new project. You can then continue filling it with the relevant information.

What should be in a README file? - Ideally all the answers to the questions posed under the metadata section should be given in the README file. To determine what should be best included in your README file, it can also be helpful to go through the questions of a [Research Data Management Plan](RDMP.qmd). While your README file should be very descriptive, it is also important to stay concise and clear. Avoid e.g. using jargon to improve inter-disciplinary usage.
What should be in a README file? - Ideally all the answers to the questions posed under the metadata section should be given in the README file. To determine what should be best included in your README file, it can also be helpful to go through the questions of a [Research Data Management Plan](dmp.qmd). While your README file should be very descriptive, it is also important to stay concise and clear. Avoid e.g. using jargon to improve inter-disciplinary usage.

::: {.callout-tip}
# Task 2.2: (~10 min)
Expand Down

0 comments on commit 16d1440

Please sign in to comment.