Merge pull request #53 from DRL/v1

BlobTools v1.0

Author: DRL

.gitignore

@@ -1,8 +1,17 @@
+*
+!*.md
+!*.py
+!*install
+!lib/*
+!data/
+!example/*
+!setup*
+!requirements.txt
+!MANIFEST.in
 data/nodesDB.txt
-tests/
+samtools/
 *.pyc
-*.png
-test_files/blobDB.table.txt
-test.*
 *.gz
 *.fq
+*.png
+*.sam

license.txt renamed to LICENSE.md

@@ -0,0 +1,2 @@
+include README.md
+include requirements.txt

MANIFEST.in

@@ -1,4 +1,32 @@
-# blobtools
-Application for the visualisation of (draft) genome assemblies using TAGC (Taxon-annotated Gc-Coverage) plots
+BlobTools v1.0
+===============================
+A modular command-line solution for visualisation, quality control and taxonomic partitioning of genome datasets
 
-For the documentation, please refer to https://blobtools.readme.io/
+Dependencies
+------------
+- UNIX system
+- Python 2.7+
+- ```pip```
+
+Installation
+------------
+
+    $ git clone https://github.com/DRL/blobtools.git
+    $ cd blobtools
+    $ ./install
+
+The installation script will:
+- install Python dependencies through ```pip```
+- download and install a copy of [samtools-1.5](http://www.htslib.org/download/) into the folder ```blobtools/samtools/```
+- download a copy of [NCBI TaxDump](ftp://ftp.ncbi.nlm.nih.gov/pub/taxonomy/) and create a nodesDB.txt file in ```blobtools/data/```. BlobTools will use this file for linking TaxIDs to NCBI taxonomies
+- create a BlobTools executable (```blobtools```) in the main directory
+
+Usage
+-----
+
+    $ ./blobtools -h
+
+Documentation
+-------------
+
+[blobtools.readme.io](https://blobtools.readme.io) (under reconstruction)