From 1c9cc0f5ba46876a95d67cbb5a5fb9f723bc96d0 Mon Sep 17 00:00:00 2001 From: Ben Date: Mon, 2 Mar 2020 17:38:07 +0100 Subject: pre-commit guide in README --- README | 23 +++++++++++++++++++++-- README.md | 1 - 2 files changed, 21 insertions(+), 3 deletions(-) delete mode 120000 README.md diff --git a/README b/README index 79d006e..0f97db2 100644 --- a/README +++ b/README @@ -1,3 +1,9 @@ +

+build status +GitHub +Code style: black +

+ # 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 -- cgit v1.2.3