From 5b409e6700a3c33e3ff5fff11d400b6bf45e735b Mon Sep 17 00:00:00 2001 From: "T.Tian" Date: Tue, 26 May 2020 18:17:11 +0200 Subject: [PATCH] update readme for more optional packages --- README.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 9d4e626..1748ecb 100644 --- a/README.md +++ b/README.md @@ -13,10 +13,10 @@ Ideas for reverse-engineering the WDF format is inspired by: Requirements: -- `python` version >= 3.6 -- `Numpy` -- `Matplotlib` (optional, if you want to plot the spectra in the examples) -- `Pillow` (optional, if you want to extract the white light image) +- `python>=3.6` +- `Numpy>=1.12.0` +- `Matplotlib>=2.1.0` (optional, if you want to plot the spectra in the examples) +- `Pillow>=3.4.0` (optional, if you want to extract the white light image) ## Versions hosted on PyPI: via `pip` @@ -27,12 +27,13 @@ pip install -U renishawWiRE ## `HEAD` version: via `git` + `pip` -To install the package without examples, run the following commands: +To install the package without examples, run the following commands +(installing extra `matplotlib` and `Pillow` if not present): ```bash git clone https://github.com/alchem0x2A/py-wdf-reader.git cd py-wdf-reader -pip install . +pip install -e ".[plot]" ``` Additionally if you want to test the examples, download them from the