c_cpp/lib/htslib/README.md

   1 HTSlib is an implementation of a unified C library for accessing common file
   2 formats, such as [SAM, CRAM and VCF][1], used for high-throughput sequencing
   3 data, and is the core library used by [samtools][2] and [bcftools][3].
   4 HTSlib only depends on [zlib][4].
   5 It is known to be compatible with gcc, g++ and clang.
   6
   7 HTSlib implements a generalized BAM index, with file extension `.csi`
   8 (coordinate-sorted index). The HTSlib file reader first looks for the new index
   9 and then for the old if the new index is absent.
  10
  11 This project also includes the popular tabix indexer, which indexes both `.tbi`
  12 and `.csi` formats, and the bgzip compression utility.
  13
  14 [1]: http://samtools.github.io/hts-specs/
  15 [2]: http://github.com/samtools/samtools
  16 [3]: http://samtools.github.io/bcftools/
  17 [4]: http://zlib.net/
  18
  19 ### Building HTSlib
  20
  21 See [INSTALL](INSTALL) for complete details.
  22 [Release tarballs][download] contain generated files that have not been
  23 committed to this repository, so building the code from a Git repository
  24 requires extra steps:
  25
  26 ```sh
  27 autoheader     # If using configure, generate the header template...
  28 autoconf       # ...and configure script (or use autoreconf to do both)
  29 ./configure    # Optional, needed for choosing optional functionality
  30 make
  31 make install
  32 ```
  33
  34 [download]: http://www.htslib.org/download/