Clarified documentation on BamReader::GetNextAlignmentCore

[bamtools.git] / README

diff --git a/README b/README
index 639bfd107d103185d08973bd77cf79a736271233..498f4be06dc0ecc00162c43cdaa65841cea5dff8 100644 (file)
--- a/README
+++ b/README
@@ -1,11 +1,60 @@
----------------
-README
-----------------
+--------------------------------------------------------------------------------
+README : BAMTOOLS
+--------------------------------------------------------------------------------
 
-Copy the 4 header files (*.h) and the library file (libbambc.a) to your directory.
+BamTools provides both a programmer's API and an end-user's toolkit for handling
+BAM files.
 
-When you compile your program, add this to the g++ command:
+I.   Learn More
 
-           -lz -L. -lbambc
+II.  License
 
-and you should be good to go.  (Those are lower case l's, as in 'lion'.)
+III. Acknowledgements
+
+IV.  Contact
+
+--------------------------------------------------------------------------------
+I. Learn More:
+--------------------------------------------------------------------------------
+
+Installation steps, tutorial, API documentation, etc. are all now available 
+through the BamTools project wiki:
+
+https://github.com/pezmaster31/bamtools/wiki
+
+Join the mailing list(s) to stay informed of updates or get involved with 
+contributing:
+
+https://github.com/pezmaster31/bamtools/wiki/Mailing-lists
+
+--------------------------------------------------------------------------------
+II. License :
+--------------------------------------------------------------------------------
+
+Both the BamTools API and toolkit are released under the MIT License.
+Copyright (c) 2009-2010 Derek Barnett, Erik Garrison, Gabor Marth,
+    Michael Stromberg
+
+See included file LICENSE for details.
+
+--------------------------------------------------------------------------------
+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.
+
+--------------------------------------------------------------------------------
+IV. Contact :
+--------------------------------------------------------------------------------
+
+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