diff options
author | Ben <b-schaefer@posteo.de> | 2020-03-02 17:38:07 +0100 |
---|---|---|
committer | Diego Elio Pettenò <flameeyes@flameeyes.com> | 2020-03-08 00:35:40 +0100 |
commit | 1c9cc0f5ba46876a95d67cbb5a5fb9f723bc96d0 (patch) | |
tree | ebd1df04c487cfce120905b72ce78d5e5dceada6 /README | |
parent | add configuration for pre-commit, black and isort (diff) | |
download | glucometerutils-1c9cc0f5ba46876a95d67cbb5a5fb9f723bc96d0.tar glucometerutils-1c9cc0f5ba46876a95d67cbb5a5fb9f723bc96d0.tar.gz glucometerutils-1c9cc0f5ba46876a95d67cbb5a5fb9f723bc96d0.tar.bz2 glucometerutils-1c9cc0f5ba46876a95d67cbb5a5fb9f723bc96d0.tar.lz glucometerutils-1c9cc0f5ba46876a95d67cbb5a5fb9f723bc96d0.tar.xz glucometerutils-1c9cc0f5ba46876a95d67cbb5a5fb9f723bc96d0.tar.zst glucometerutils-1c9cc0f5ba46876a95d67cbb5a5fb9f723bc96d0.zip |
Diffstat (limited to '')
-rw-r--r-- | README | 23 | ||||
l--------- | README.md | 1 |
2 files changed, 21 insertions, 3 deletions
@@ -1,3 +1,9 @@ +<p align="center"> +<a href="https://travis-ci.org/Flameeyes/glucometerutils/builds/"><img alt="build status" src="https://img.shields.io/travis/Flameeyes/glucometerutils"></a> +<a href="https://github.com/Flameeyes/glucometerutils#license"><img alt="GitHub" src="https://img.shields.io/badge/license-MIT-green"></a> +<a href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a> +</p> + # Glucometer Utilities This repository includes a command line utility to interact with a number of @@ -104,12 +110,25 @@ even if they are all from the same manufacturer, will use different protocols. If you want to contribute code, please note that the target language -is Python 3.5, and that the style to follow is for the most part PEP8 +is Python 3.6, and that the style to follow is for the most part PEP8 compatible. +To set up your development environment follow these guidelines: + +```shell +$ git clone https://github.com/Flameeyes/glucometerutils.git +$ cd glucometerutils +$ python3 -m venv --python=python3.6 +$ . venv/bin/activate +$ pip install -e .[dev] +$ # If you want to work on a specific driver specify this after dev e.g. +$ # pip install -e .[dev,myglucometer-driver] # see table above +$ pre-commit install +``` + ## License -Copyright © 2013-2019 The glucometerutils Authors +Copyright © 2013-2020 The glucometerutils Authors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the diff --git a/README.md b/README.md deleted file mode 120000 index 100b938..0000000 --- a/README.md +++ /dev/null @@ -1 +0,0 @@ -README
\ No newline at end of file |