aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 8 insertions, 2 deletions
diff --git a/README.md b/README.md
index f73731f..19f66a5 100644
--- a/README.md
+++ b/README.md
@@ -112,10 +112,11 @@ This is the current structure of the GEMMA source repository:
├── doc
├── example
└── src
- └── Eigen
```
-*Explain here what is in each of the subfolders.*
+*Write a paragraph here briefly explaining what is in each of the
+subfolders; see Wilson et al "Good Enough Practices" paper for example
+of this.*
## Setup
@@ -173,6 +174,11 @@ You will need a standard C/C++ compiler such as GNU gcc, as well as
[LAPACK](http://www.netlib.org/lapack) libraries. You will need to
change the library paths in the Makefile accordingly.
+*Revise this step:* You will need to download the
+[Eigen C++ library](http://eigen.tuxfamily.org), and copy the `Eigen`
+subdirectory into the `src` directory of the GEMMA repository. (It was
+last tested using Eigen version 3.3.3.)
+
## Credits
The *GEMMA* software was developed by: