Add stuff to data/README

vijayvarma392 · Sep 13, 2018 · 461b4da · 461b4da
1 parent 418cd05
commit 461b4da
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/surfinBH/data/README b/surfinBH/data/README
@@ -0,0 +1,8 @@
+# data directory
+
+This directory contains the fit data. Fit data gets downloaded to this
+directory using surfinBH.DownloadData().
+
+DO NOT commit the files in this directory.
+However, make sure that this directory contains data for all fits before
+uploading a new version to pip.