debian-changes
authorDebian Med Packaging Team <debian-med-packaging@lists.alioth.debian.org>
Wed, 24 Sep 2014 12:24:11 +0000 (12:24 +0000)
committerCharles Plessy <plessy@debian.org>
Wed, 24 Sep 2014 12:24:11 +0000 (12:24 +0000)
Gbp-Pq: Name debian-changes

.travis.yml [new file with mode: 0644]
README.md [new file with mode: 0644]

diff --git a/.travis.yml b/.travis.yml
new file mode 100644 (file)
index 0000000..3e1c43a
--- /dev/null
@@ -0,0 +1,8 @@
+# Control file for continuous integration testing at http://travis-ci.org/
+
+language: c
+compiler:
+  - clang
+  - gcc
+
+script: make -e && make test
diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..bcd1b6a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,17 @@
+HTSlib is an implementation of a unified C library for accessing common file
+formats, such as [SAM, CRAM and VCF][1], used for high-throughput sequencing
+data, and is the core library used by [samtools][2] and [bcftools][3].
+HTSlib only depends on [zlib][4].
+It is known to be compatible with gcc, g++ and clang.
+
+HTSlib implements a generalized BAM index, with file extension `.csi`
+(coordinate-sorted index). The HTSlib file reader first looks for the new index
+and then for the old if the new index is absent.
+
+This project also includes the popular tabix indexer, which indexes both `.tbi`
+and `.csi` formats, and the bgzip compression utility.
+
+[1]: http://samtools.github.io/hts-specs/
+[2]: http://github.com/samtools/samtools
+[3]: http://samtools.github.io/bcftools/
+[4]: http://zlib.net/