From 4368bc3812629040a07e4d022ec0129807039ff3 Mon Sep 17 00:00:00 2001
From: Brian Qiu <brianqiu2000@gmail.com>
Date: Sat, 12 Dec 2015 12:53:15 -0800
Subject: [PATCH] Added/updated readmes in project, data, code, paper

---
 README.md       | 11 ++++++++++-
 code/README.md  | 10 ++++++++++
 data/README.md  |  3 ++-
 paper/README.md |  6 ++++++
 4 files changed, 28 insertions(+), 2 deletions(-)
 create mode 100644 code/README.md
 create mode 100644 paper/README.md

diff --git a/README.md b/README.md
index 8420983..cdd00ba 100644
--- a/README.md
+++ b/README.md
@@ -10,4 +10,13 @@ _**Topic:**_ [The Neural Basis of Loss Aversion in Decision Making Under Risk] (
 [SOME SUMMARY OF PAPER]
 
 ## Instructions
-[NEED TO ADD]
\ No newline at end of file
+
+- 'make clean' will delete extraneous files created by our scripts
+- 'make coverage' will check the coverage of our data, code directories 
+- 'make test' will run the tests in our code/utils/tests and code/data/tests directory
+- 'make verbose' is the verbose version of 'make test'
+
+
+
+
+[NEED TO ADD: instructions for data, scripts/analysis, paper (should be done in that order)]
diff --git a/code/README.md b/code/README.md
new file mode 100644
index 0000000..b529a47
--- /dev/null
+++ b/code/README.md
@@ -0,0 +1,10 @@
+##CODE
+
+The code folder contains two subdirectories. Utils contains our functions for 
+analysis, our functions for graphing, and our tests. Scripts contains the 
+scripts that utilize these functions.
+
+Our makefile is written such that when run from the code directory:
+
+- 'make test' will run the tests inside utils/tests to check our functions
+- 'make coverage' will check the coverage of our functions
diff --git a/data/README.md b/data/README.md
index 628b8b1..79cfc13 100644
--- a/data/README.md
+++ b/data/README.md
@@ -1,7 +1,8 @@
 The ds005 dataset, filtered ds005 dataset, and mni templates are stored here. Th
 e makefile is written such that:
  
-- `make data` will pull in the appropriate data 
+- `make data` will pull in the appropriate data. NOTE: ds005 will be 16.7 GB, so
+can take a while to download 
 - `make unzip` will unzip, remove, and rename certain files
 - `make validate` will run data.py to check the hashes of each downloaded file w
 ith a master hashlist included, ensuring all downloaded data is correct  
diff --git a/paper/README.md b/paper/README.md
new file mode 100644
index 0000000..c55131a
--- /dev/null
+++ b/paper/README.md
@@ -0,0 +1,6 @@
+##Paper
+
+The makefile is written such that:
+
+- 'make all' will generate our paper in PDF format
+- 'make clean' will delete all extraneous files generated by 'make all'