aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorPeter Carbonetto2017-05-26 12:56:40 -0500
committerPeter Carbonetto2017-05-26 12:56:40 -0500
commit8d825084f7d53e754ade934edf9ee0628028f869 (patch)
tree7bb7403871777be5f4d7901982d2821ce0af1383 /README.md
parent5d26ca0f8a4bb3da47ed94f26038f7c92dd46b97 (diff)
downloadpangemma-8d825084f7d53e754ade934edf9ee0628028f869.tar.gz
Added What's Included section to README.
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md
index fedb392..b44348b 100644
--- a/README.md
+++ b/README.md
@@ -97,6 +97,24 @@ warranty**; without even the implied warranty of **merchantability or
fitness for a particular purpose**. See file [LICENSE](LICENSE) for
the full text of the license.
+## What's included
+
+This is the current structure of the GEMMA source repository:
+
+```
+├── LICENSE
+├── Makefile
+├── NEWS.md
+├── README.md
+├── bin
+├── doc
+├── example
+└── src
+ └── Eigen
+```
+
+*Explain here what is in each of the subfolders.*
+
## Setup
There are two ways to install GEMMA: