From 4096c59f75a56f4164f354c570dec98601a3c326 Mon Sep 17 00:00:00 2001 From: Sander Bollen Date: Tue, 7 May 2019 16:41:04 +0200 Subject: [PATCH] prepare docs for pip --- README.md | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 4a76129..2bed967 100644 --- a/README.md +++ b/README.md @@ -134,14 +134,18 @@ Options: ## Installation -* Python 3.6 at minimum -* numpy and cython must be installed prior to installing vtools - * this will get fixed in the very near future - -After both requirements have been met, simply install vtools with +vtools is now on pip! Since the 'vtools' name is already taken by another +package, installing _this_ vtools requires installing the following: ```bash -python setup.py install +pip install v-tools +``` + +After installation, tools will still be called `vtools-`. Programmatic +access also simply works with + +```python +import vtools ``` ## License -- GitLab