aboutsummaryrefslogtreecommitdiff
path: root/README.txt
diff options
context:
space:
mode:
Diffstat (limited to 'README.txt')
-rw-r--r--README.txt24
1 files changed, 24 insertions, 0 deletions
diff --git a/README.txt b/README.txt
new file mode 100644
index 0000000..9297492
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,24 @@
+PROGRAM: Genome-wide Efficient Mixed Model Association (GEMMA)
+
+AUTHOR: Xiang Zhou
+
+YEAR: 2012
+
+DOCUMENTATION: A detailed user manual is available online and a recent version is provided inside the doc directory. A brief description is also available if you type "./gemma -h". Please refer to the online user manual for updated information.
+
+LICENSE: Distributed under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+
+INSTALLATION: An executable binary (x86 64bit Linux) is available in the bin directory. No installation is necessary if the executable works in your system. Otherwise, see compilation section below.
+
+COMPILATION: You will need a standard C/C++ compiler such as GNU gcc, as well as GSL, LAPACK libraries. You will need to change the library paths in the Makefile accordingly.
+
+For details on installing GSL library, please refer to:
+http://www.gnu.org/s/gsl/
+
+For details on installing LAPACK library, please refer to:
+http://www.netlib.org/lapack/
+
+USAGE: Type "./gemma" from the command line followed by the options of choice. Type "./gemma -h" for a brief description. Please refer to the online user manual for detailed and updated information.
+
+Xiang Zhou, December 2012
+