đź“ť
Digital Skills GitBook
  • Digital Skills GitBook
  • Code of Conduct
  • Copyright Statement
  • Contributing to the Digital Skills GitBook
  • 1. Digital identity and wellbeing
    • Developing a digital presence
    • Phishing and identity theft
    • Using password managers
  • 2. Information literacy, media literacy and data literacy
    • Discerning fake news
    • Types of Data
    • ISO dates
    • Searching via databases
  • 3. Digital learning and development
    • Creating engaging online learning
    • Accessibility
    • Navigating the learning management system (LMS)
    • Pedagogy and andragogy in an online environment
  • 4. ICT proficiency and productivity
    • Installing and accessing browsers
    • Using spreadsheet applications
    • Digital preservation: file formats and how to change them
    • Creating a directory structure
    • Opening, editing and saving documents
    • Naming and organising files and folders
    • Printing documents
    • Accessing and sending emails
    • README files
    • Networks: the internet and how it works
    • Using QR codes
  • 5. Digital creation, problem solving and innovation
    • Git and GitHub
    • Markdown
    • Screencasting
  • 6. Collaboration, communication and participation
    • Using collaborative documents
  • Glossary
  • Requested articles
  • Our talks, presentations and articles
  • VALA 2024 Poster Presentation
Powered by GitBook
On this page
  • Overview
  • Developing
  • Skilled
  • Helpful resources

Was this helpful?

Edit on GitHub
Export as PDF
  1. 4. ICT proficiency and productivity

README files

PreviousAccessing and sending emailsNextNetworks: the internet and how it works

Last updated 2 years ago

Was this helpful?

Overview

A README file is a document that introduces and explains a project, helping colleagues and your future self navigate through a past project (Briney, 2014).

Developing

README files contain information about the other files in a directory or folder. The concept comes from programming but is also very useful for research projects. It is usually a simple plain text file called README in capital letters.

A good README includes information that helps the reader understand what the project is about, including helping them do basic navigation through the subfolders (Briney, 2014).

Skilled

README files can be used to record . They are important for capturing related to research projects and datasets.

Helpful resources

Here are some good resources and templates used for creating README files so that you know what information you should include about your project:

These are more detailed guides on what to include in a README file for a research project, with links to templates:

Briney, K. (2014, February 25). README.txt. Data Ab Initio: Managing Research Data Right, from the Start.

data provenance
metadata
README editor
Make a README
Research Data Management: Guide to writing “readme” type metadata
Guide to writing "readme" style metadata
http://dataabinitio.com/?p=378