From 72dae1893d2f3dbb80bfebfa5ea34a789c3c3393 Mon Sep 17 00:00:00 2001 From: Sander Bollen <a.h.b.bollen@lumc.nl> Date: Wed, 15 May 2019 16:17:35 +0200 Subject: [PATCH] update readme --- README.md | 41 +++++++++++++++++++++++++---------------- 1 file changed, 25 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 2bed967..3f78160 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,34 @@ +[](http://bioconda.github.io/recipes/vtools/README.html) + vtools ====== Little toolset operating over VCF files. Uses cyvcf2 and cython under the hood for speed. +## Installation + +### PyPI +vtools is now on pip! Since the 'vtools' name is already taken by another +package, installing _this_ vtools requires installing the following: + +```bash +pip install v-tools +``` + +After installation, tools will still be called `vtools-<tool>`. Programmatic +access also simply works with + +```python +import vtools +``` + +### Conda + +```bash +conda install -c bioconda vtools +``` + Tools ----- @@ -132,22 +157,6 @@ Options: --help Show this message and exit. ``` -## Installation - -vtools is now on pip! Since the 'vtools' name is already taken by another -package, installing _this_ vtools requires installing the following: - -```bash -pip install v-tools -``` - -After installation, tools will still be called `vtools-<tool>`. Programmatic -access also simply works with - -```python -import vtools -``` - ## License MIT -- GitLab