From b8aa129750be9a6a56f14987401010edc8514b32 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Diego=20Elio=20Petten=C3=B2?= Date: Thu, 28 Dec 2017 21:35:33 +0000 Subject: Add driver dependencies to setup.py, and document how to install this. This should address Issue 5 (theoretically some of the dependencies are OS-specific but that's a longer problem). Also partially addresses Issue 9 because now we have an easy to understand "install and try out" option. --- README | 14 ++++++++++++++ 1 file changed, 14 insertions(+) (limited to 'README') diff --git a/README b/README index d87f3b8..a070a05 100644 --- a/README +++ b/README @@ -13,6 +13,20 @@ follows: * `datetime` reads or updates the date and time of the device clock. * `zero` deletes all the recorded readings (only implemented for few devices). +## Example Usage + +Most of the drivers require optional dependencies, and those are listed in the +table below. If you do not want to install the dependencies manually, you should +be able to set this up using `virtualenv` and `pip`: + +```shell +$ python3 -m venv $(pwd)/glucometerutils-venv +$ . glucometerutils-venv/bin/activate +(glucometerutils-venv) $ DRIVER=myglucometer-driver # see table below +(glucometerutils-venv) $ pip install git+https://github.com/Flameeyes/glucometerutils.git#egg=project[${DRIVER}] +(glucometerutils-venv) $ glucometer --driver ${DRIVER} help +``` + ## Supported devices Please see the following table for the driver for each device that is known and -- cgit v1.2.3