]> git.donarmstrong.com Git - bamtools.git/blob - README
Clarified documentation on BamReader::GetNextAlignmentCore
[bamtools.git] / README
1 --------------------------------------------------------------------------------
2 README : BAMTOOLS
3 --------------------------------------------------------------------------------
4
5 BamTools provides both a programmer's API and an end-user's toolkit for handling
6 BAM files.
7
8 I.   Learn More
9
10 II.  License
11
12 III. Acknowledgements
13
14 IV.  Contact
15
16 --------------------------------------------------------------------------------
17 I. Learn More:
18 --------------------------------------------------------------------------------
19
20 Installation steps, tutorial, API documentation, etc. are all now available 
21 through the BamTools project wiki:
22
23 https://github.com/pezmaster31/bamtools/wiki
24
25 Join the mailing list(s) to stay informed of updates or get involved with 
26 contributing:
27
28 https://github.com/pezmaster31/bamtools/wiki/Mailing-lists
29
30 --------------------------------------------------------------------------------
31 II. License :
32 --------------------------------------------------------------------------------
33
34 Both the BamTools API and toolkit are released under the MIT License.
35 Copyright (c) 2009-2010 Derek Barnett, Erik Garrison, Gabor Marth,
36     Michael Stromberg
37
38 See included file LICENSE for details.
39
40 --------------------------------------------------------------------------------
41 III. Acknowledgements :
42 --------------------------------------------------------------------------------
43
44  * Aaron Quinlan for several key feature ideas and bug fix contributions
45  * Baptiste Lepilleur for the public-domain JSON parser (JsonCPP)
46  * Heng Li, author of SAMtools - the original C-language BAM API/toolkit.
47
48 --------------------------------------------------------------------------------
49 IV. Contact :
50 --------------------------------------------------------------------------------
51
52 Feel free to contact me with any questions, comments, suggestions, bug reports,
53     etc.
54
55 Derek Barnett
56 Marth Lab
57 Biology Dept., Boston College
58
59 Email: derekwbarnett@gmail.com
60 Project Website: http://github.com/pezmaster31/bamtools