2.3 README files

The top level README file should contain all the information about what the project is and how to get started. It should link to (or contain) the metadata information from the previous example. Remember this is the first thing people will see when they open a repository, the more information here about where things are, the better.

2.3.1 Example File

# Datasets

- my_awesome_dataset.csv
    - ./data/folder/original/awesome/my_awesome_dataset.csv
    - contains data about how awesome the various datasets are
    - used to calculate the 'awesome' metric

- web_scraped_data.RData
    - data scraped from the web
    - comes from ./src/dan/web/scraping.R

# Figures

- ./output/poster_fig_1.png
    - scatter plot for the amazing data
    - generated by: `./src/dan/amazing/plot_code.R`


- ./output/poster_fig_2.pdf
    - violin plotfor the amazing data
    - generated by: `./src/dan/amazing/plot_code_42.R`