INSTALL

   1 System Requirements
   2 ===================
   3
   4 SAMtools depends on the zlib library <http://www.zlib.net>. The latest
   5 version 1.2.3 is preferred and with the latest version you can compile
   6 razip and use it to compress a FASTA file. SAMtools' faidx is able to
   7 index a razip-compressed FASTA file to save diskspace. Older zlib also
   8 works with SAMtools, but razip cannot be compiled.
   9
  10 The text-based viewer (tview) requires the GNU ncurses library
  11 <http://www.gnu.org/software/ncurses/>, which comes with Mac OS X and
  12 most of the modern Linux/Unix distributions. If you do not have this
  13 library installed, you can still compile the rest of SAMtools by
  14 manually modifying two lines in Makefile as is described in the
  15 Makefile.
  16
  17
  18 Compilation
  19 ===========
  20
  21 Type `make' to compile samtools. If you have zlib >= 1.2.2.1, you can
  22 compile razip with `make razip'.
  23
  24
  25 Installation
  26 ============
  27
  28 Simply copy `samtools' and other executables/scripts in `misc' to a
  29 location you want (e.g. a directory in your $PATH). No further
  30 configurations are required.