summaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorDiego Elio Pettenò <flameeyes@flameeyes.eu>2017-12-28 22:35:33 +0100
committerDiego Elio Pettenò <flameeyes@flameeyes.eu>2017-12-28 22:35:33 +0100
commitb8aa129750be9a6a56f14987401010edc8514b32 (patch)
tree4bc552a7e9da6d00c29f6f35923431f00e328f03 /README
parentRewrite setup.py to use setuptools. (diff)
downloadglucometerutils-b8aa129750be9a6a56f14987401010edc8514b32.tar
glucometerutils-b8aa129750be9a6a56f14987401010edc8514b32.tar.gz
glucometerutils-b8aa129750be9a6a56f14987401010edc8514b32.tar.bz2
glucometerutils-b8aa129750be9a6a56f14987401010edc8514b32.tar.lz
glucometerutils-b8aa129750be9a6a56f14987401010edc8514b32.tar.xz
glucometerutils-b8aa129750be9a6a56f14987401010edc8514b32.tar.zst
glucometerutils-b8aa129750be9a6a56f14987401010edc8514b32.zip
Diffstat (limited to '')
-rw-r--r--README14
1 files changed, 14 insertions, 0 deletions
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