X-Git-Url: http://woldlab.caltech.edu/gitweb/?p=samtools.git;a=blobdiff_plain;f=INSTALL;h=37d84a9e48b3247f8b807d7d983e182e17bb1204;hp=f1cf7aa4079ca1302608dd81c59a7882597975ee;hb=ced7709f121a00d5049d99ee8576037994aab1d1;hpb=b27e00385f41769d03a8cca4dbd71275fc9fa906 diff --git a/INSTALL b/INSTALL index f1cf7aa..37d84a9 100644 --- a/INSTALL +++ b/INSTALL @@ -1,29 +1,30 @@ System Requirements =================== -SAMtools depends on the zlib library . The latest -version 1.2.3 is preferred and with the latest version you can compile -razip and use it to compress a FASTA file. SAMtools' faidx is able to -index a razip-compressed FASTA file to save diskspace. Older zlib also -works with SAMtools, but razip cannot be compiled. +SAMtools depends on the zlib library . Version 1.2.3+ is +preferred and with 1.2.3+ you can compile razip and use it to compress a FASTA +file. SAMtools' faidx is able to index a razip-compressed FASTA file to save +diskspace. Older zlib also works with SAMtools, but razip cannot be compiled. The text-based viewer (tview) requires the GNU ncurses library -, 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 one line in Makefile. +, 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 changing: +`-D_CURSES_LIB=1' to `-D_CURSES_LIB=0' at the line starting with `DFLAGS=', and +comment out the line starting with `LIBCURSES='. Compilation =========== -Type `make' to compile samtools. If you have zlib >= 1.2.2.1, you can -compile razip with `make razip'. +Type `make' to compile samtools. If you have zlib >= 1.2.2.1, you can compile +razip with `make razip'. 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. +Copy `samtools', `bcftools/bcftools' and other executables/scripts in `misc' to +a location you want (e.g. a directory in your $PATH). You may also copy +`samtools.1' and `bcftools/bcftools.1' to a directory in your $MANPATH such +that the `man' command may find the manual.