diff --git a/README.md b/README.md index a72e50b..e5eb358 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,24 @@ # Sartorius Logger Make time series measurements with a Sartorius scale. + + +## Development + +To install the development version of sartorius logger: + + git clone https://git.cpi.imtek.uni-freiburg.de/holgi/sartoriuslogger + cd sartoriuslogger + + # create a virtual environment and activate it + python3 -m venv --prompt sartorius .venv + .venv/bin/activate + + # upgrade pip, install flit and sartoriuslogger + python3 -m pip install --upgrade pip + python3 -m pip install flit + python3 -m flit install --pth-file + +To run the tests, run `make tests` or `make coverage` for a complete report. + +To build the SartoriusLogger windows app, run the `make.bat` file.