Skip to content

Instantly share code, notes, and snippets.

@jlant

jlant/template-readme-data.md

Last active August 29, 2015 14:21
Show Gist options
  • Save jlant/8333ce80e87c111cd718 to your computer and use it in GitHub Desktop.
Save jlant/8333ce80e87c111cd718 to your computer and use it in GitHub Desktop.
Download ZIP
Template - readme for data files. Some advice and best practices from - http://data.research.cornell.edu/content/readme
Raw
template-readme-data.md

yyyy-mm-dd-topic-source

Short description of data.

Dates

Collected - yyyy-mm-dd (single date) or yyyy-mm-dd - yyyy-mm-dd (range of dates)
Received - yyyy-mm-dd

Source

Type - website | company | personal contact
URL -

name
title, company
address
phone
email

Content

Type/Format - csv, tsv, json, code, etc.
Topic - engineering, physics, astronomy, earth sciences, hydrology, etc.

Description

Long description of data content.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment