]> git.donarmstrong.com Git - samtools.git/blobdiff - INSTALL
* update Makefile
[samtools.git] / INSTALL
diff --git a/INSTALL b/INSTALL
index faa3eaf10d66354329abd106c4f27d4230f8756c..f202463b76f788401442d6f9fb29d7ea7a5e429d 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,8 +1,24 @@
-Compiling samtools requires the zlib library <http://www.zlib.net/>;
-compiling the alignment viewer further requires the GNU ncurses library
-<http://www.gnu.org/software/ncurses/>.
-
-Please type `./configure; make' to compile samtools. If it fails, try
-`make -f Makefile.generic'. If the compilation still fails due to errors
-in RAZF or the lack of ncurses, try `make -f Makefile.lite' to disable
-the alignment viewer and the RAZF-enhanced FASTA indexer.
+System Requirements
+===================
+
+Most of SAMtools functionality only depends on zlib which is included in
+this source code package. Compiling the alignment viewer further
+requires the GNU ncurses library <http://www.gnu.org/software/ncurses/>,
+which comes with Mac OS X and most of the modern Linux/Unix
+distributions. If you do not have this library installed, you can still
+compile the rest of SAMtools by manually modifying two lines in Makefile
+as is described in the Makefile.
+
+
+Compilation
+===========
+
+Type `make' to compile samtools.
+
+
+Installation
+============
+
+Simply copy `samtools' and other executables/scripts in `misc' to a
+location you want (e.g. a directory in your $PATH). No further
+configurations are required.