Skip to content

Commit 08fa598

Browse files
committed
Updated README
1 parent 527565a commit 08fa598

File tree

1 file changed

+47
-4
lines changed

1 file changed

+47
-4
lines changed

README.md

Lines changed: 47 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,56 @@
11
# blobtools
2-
Application for the visualisation of draft genome assemblies and general QC
2+
Application for the visualisation of (draft) genome assemblies and general assembly QC using TAGC (Taxon-annotated Gc-Coverage) plots [Kumar et al. 2012](http://www.ncbi.nlm.nih.gov/pmc/articles/PMC3843372/pdf/fgene-04-00237.pdf).
33

4-
- Requirements
4+
## Requirements
55

66
```
7-
pip install matplotlib
8-
pip install docopt
7+
- Python 2.7+
8+
- Matplotlib 1.5
9+
- Docopt
10+
- Virtualenv (Recommended, see [tutorial](http://docs.python-guide.org/en/latest/dev/virtualenvs/))
911
```
1012

13+
## Installation
14+
- Recommended
15+
```
16+
# install virtualenv
17+
pip install virtualenv
18+
19+
# clone blobtools into folder
20+
git clone https://github.com/DRL/blobtools.git
21+
22+
# create virtual environment for blobtools
23+
cd blobtools/
24+
virtualenv blob_env
25+
26+
# activate virtual environment
27+
source blob_env/bin/activate
28+
29+
# install matplotlib
30+
(blob_env) $ pip install matplotlib
31+
32+
# install docopt
33+
(blob_env) $ pip install docopt
34+
35+
# run
36+
(blob_env) $ ./blobtools -h
37+
```
38+
- Basic
39+
```
40+
# clone blobtools into folder
41+
$ git clone https://github.com/DRL/blobtools.git
42+
43+
# install matplotlib
44+
$ pip install matplotlib
45+
46+
# install docopt
47+
$ pip install docopt
48+
49+
# run
50+
$ ./blobtools -h
51+
```
52+
53+
## Doc
1154
- blobtools : main executable
1255
```
1356
usage: blobtools <command> [<args>...] [--help]

0 commit comments

Comments
 (0)