aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorPeter Carbonetto2017-07-08 11:52:18 -0500
committerGitHub2017-07-08 11:52:18 -0500
commit1311f55dd359036f5e2ddf83784ce54c8dff3cd7 (patch)
tree0bf67c872f0fe21eaa97e572fbbf0d454ca9ef54 /README.md
parent86e96ede4ff0955bb2d03ac6c1bd7562a3984955 (diff)
parent3b618e92899f3e8fde462ebeccf8310d8bd9addc (diff)
downloadpangemma-1311f55dd359036f5e2ddf83784ce54c8dff3cd7.tar.gz
Merge pull request #53 from genenetwork/doc
Updated README and created INSTALL.
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 9 insertions, 9 deletions
diff --git a/README.md b/README.md
index a539cc0..0dfac6c 100644
--- a/README.md
+++ b/README.md
@@ -50,7 +50,7 @@ MQS algorithm to estimate variance components.
## Quick start
-1. Download and install the software. *Give more details here.*
+1. Download and install the software. See [INSTALL.md](INSTALL.md).
2. Work through the demo. *Give more details here.*
@@ -120,21 +120,20 @@ of this.*
## Setup
-There are two ways to install GEMMA:
+To install GEMMA you can
1. Download the precompiled binaries (64-bit Linux and Mac only).
-2. Compile the GEMMA executable from source.
+2. Use existing package managers, see [INSTALL.md](INSTALL.md).
-The first option is simpler, and is therefore recommended for
-most users.
+3. Compile the GEMMA executable from source.
Compiling from source takes more work, but can boost performance of
the program, especially when using specialized C++ compilers and
numerical libraries.
-In both cases, we recommend downloading the
-[latest stable release][latest_release] instead of the Github repository.
+Source code and [latest stable release][latest_release] are available
+from the Github repository.
### Precompiled binaries
@@ -162,8 +161,6 @@ errors.
### Building from source
-*Provde a brief list the dependencies here.*
-
*We provide a simple Makefile which will need to be customized; please
see the comments at the top of the Makefile. Explain why we
automatically generate a Makefile using programs such as CMake or
@@ -179,6 +176,9 @@ change the library paths in the Makefile accordingly.
subdirectory into the `src` directory of the GEMMA repository. (It was
last tested using Eigen version 3.3.3.)
+More information on source code, dependencies and installation can be
+found in [INSTALL.md](INSTALL.md).
+
## Credits
The *GEMMA* software was developed by: