-------------------------------------------------------------
+--------------------------------------------------------------------------------
README : BAMTOOLS
-------------------------------------------------------------
+--------------------------------------------------------------------------------
-BamTools: a C++ API for reading/writing BAM files.
+BamTools provides both a programmer's API and an end-user's toolkit for handling
+BAM files.
-I. Introduction
-II. Usage
-III. Contact
+I. Learn More
-------------------------------------------------------------
+II. License
+III. Acknowledgements
-I. Introduction:
+IV. Contact
-The API consists of 2 main modules - BamReader and BamWriter. As you would expect,
-BamReader provides read-access to BAM files, while BamWriter does the writing of BAM
-files. BamReader provides an interface for random-access (jumping) in a BAM file,
-as well as generating BAM index files.
-
-An additional file, BamAux.h, is included as well.
-This file contains the common data structures and typedefs used throught the API.
+--------------------------------------------------------------------------------
+I. Learn More:
+--------------------------------------------------------------------------------
-BGZF.h & BGZF.cpp contain our implementation of the Broad Institute's
-BGZF compression format.
+Installation steps, tutorial, API documentation, etc. are all now available
+through the BamTools project wiki:
-BamConversion, BamDump, and BamTrim are 3 'toy' examples on how the API can be used.
+https://github.com/pezmaster31/bamtools/wiki
-------------------------------------------------------------
+Join the mailing list(s) to stay informed of updates or get involved with
+contributing:
-Usage :
+https://github.com/pezmaster31/bamtools/wiki/Mailing-lists
-To use this API, you simply need to do 3 things:
+--------------------------------------------------------------------------------
+II. License :
+--------------------------------------------------------------------------------
- 1 - Drop the BamTools files somewhere the compiler can find them.
- (i.e. in your source tree, or somewhere else in your include path)
+Both the BamTools API and toolkit are released under the MIT License.
+Copyright (c) 2009-2010 Derek Barnett, Erik Garrison, Gabor Marth,
+ Michael Stromberg
- 2 - Import BamTools API with the following lines of code
- #include "BamReader.h" // as needed
- #include "BamWriter.h" // as needed
- using namespace BamTools;
-
- 3 - Compile with '-lz' ('l' as in Lima) to access ZLIB compression library
- (For VS users, I can provide you zlib headers - just contact me).
+See included file LICENSE for details.
-See any included programs and Makefile for more specific compiling/usage examples.
-See comments in the header files for more detailed API documentation.
+--------------------------------------------------------------------------------
+III. Acknowledgements :
+--------------------------------------------------------------------------------
-------------------------------------------------------------
+ * Aaron Quinlan for several key feature ideas and bug fix contributions
+ * Baptiste Lepilleur for the public-domain JSON parser (JsonCPP)
+ * Heng Li, author of SAMtools - the original C-language BAM API/toolkit.
-Contact :
+--------------------------------------------------------------------------------
+IV. Contact :
+--------------------------------------------------------------------------------
-Feel free to contact me with any questions, comments, suggestions, bug reports, etc.
- - Derek Barnett
-
-http://sourceforge.net/projects/bamtools
+Feel free to contact me with any questions, comments, suggestions, bug reports,
+ etc.
+
+Derek Barnett
+Marth Lab
+Biology Dept., Boston College
+
+Email: derekwbarnett@gmail.com
+Project Website: http://github.com/pezmaster31/bamtools
projects / bamtools.git / blobdiff