README.rdoc in bio-samtools-0.2.5 vs README.rdoc in bio-samtools-0.3.0

- old
+ new

@@ -11,33 +11,20 @@ This project was born from the need to add support of BAM files to the gee_fu genome browser (http://github.com/danmaclean/gee_fu). == Installation -At the moment, the only way to "install" the module is to copy it to copy the content -of the lib folder on any lib folder you have. You must also copy your libbam.a (linux) -or libbam.dll (windows) from samtools. If you have a Mac, add the following variable -to the makefile of samtools +'gem install bio-samtools' -DYFLAGS = -dynamiclib -lz - -and the following target: -dylib: libbam.dylib -libbam.dylib:$(LOBJS) - $(CC) $(CFLAGS) $(DYFLAGS) -o libbam.dylib $(LOBJS) - -Then, run - -make dylib - -Finally, you copy the .dylib file to your lib folder. - == Usage -The easiest way to see in "action" samtools-ruby to call -rake test. +The easiest way to see bio-samtools in action is to try the tests +rake basic_test +rake pileup_test +See doc/tutorial.html or doc/tutorial.pdf for a walkthrough tutorial + == Dependencies: -FFI (http://github.com/ffi/ffi) -libbam This can be obtained from samtools. (http://samtools.sourceforge.net/ ) @@ -48,12 +35,12 @@ -When you try to lad a binary file as a text file If this is not the problem, or you have any other question, donĀ“t hesitate on dropping a line to Ricardo dot Ramirez-Gonzalez at bbsrc dot ac dot uk +dan.maclean@tsl.ac.uk == TODO --Write a gem to install it -Filter to the fetching algorithm (give a condition that has to be satisfied to add the alignment to the list) -Examples of how to use it, besides the test folder -Operating system independent, DONE ( test needed) == IMPORTANT NOTE