]> git.donarmstrong.com Git - bamtools.git/commitdiff
Updated README
authorbarnett <barnett@9efb377e-2e27-44b9-b91a-ec4abb80ed8b>
Wed, 15 Jul 2009 18:06:13 +0000 (18:06 +0000)
committerbarnett <barnett@9efb377e-2e27-44b9-b91a-ec4abb80ed8b>
Wed, 15 Jul 2009 18:06:13 +0000 (18:06 +0000)
git-svn-id: svn+ssh://gene.bc.edu/home/subversion/Derek/BamTools/trunk@21 9efb377e-2e27-44b9-b91a-ec4abb80ed8b

README

diff --git a/README b/README
index a523b4c1d707e6b5f010609638e024cc142d5527..92f88d152efd75d0fb237577f3e14758db400beb 100644 (file)
--- a/README
+++ b/README
@@ -1,5 +1,5 @@
 ------------------------------------------------------------
-    README
+README : BAMTOOLS
 ------------------------------------------------------------
 
 BamTools: a C++ API for reading/writing BAM files.
@@ -16,15 +16,14 @@ This file contains the common data structures and typedefs used throught the API
 To use this API, you simply need to do 3 things:
 
     1 - Drop the BamTools files somewhere the compiler can find them.
-           (i.e. in source directory, or somewhere in include path)
-       
-       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 'lion') to access ZLIB compression library
+        (i.e. in source directory, or somewhere in include path)
+
+    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 'lion') to access ZLIB compression library
 
 See any included programs and Makefile for more specific compiling/usage examples.
 See documentation & comments in header files for API details.