From f514ec179daa10414a077025876382ab2d03e335 Mon Sep 17 00:00:00 2001 From: Sietze van Buuren Date: Mon, 19 Aug 2024 19:12:52 +0200 Subject: [PATCH] docs: Include PyPi package in installation instructions Signed-off-by: Sietze van Buuren --- README.md | 7 +++++-- docs/installation.md | 12 +++++++++--- 2 files changed, 14 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 40db2e5..fd7e023 100644 --- a/README.md +++ b/README.md @@ -5,11 +5,14 @@ mlpyqtgraph enables [matplotlib](https://matplotlib.org/)-like plotting with ## Installation -mlpyqtgraph is a python package. You can install it just like any other python package, e.g. using `pip`: +mlpyqtgraph is a [python package](https://pypi.org/project/mlpyqtgraph/) which +is available on the [Python Package Index (PyPi)](https://pypi.org/). You can +install it just like any other python package using `pip`: ``` bash -pip install /path/to/mlpyqtgraph +pip install mlpyqtgraph ``` + For detailed installation instructions, please refer to [documentation's installation page](https://swvanbuuren.github.io/mlpyqtgraph/installation/). diff --git a/docs/installation.md b/docs/installation.md index 192322a..85fd365 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -1,9 +1,15 @@ # Installation -mlpyqtgraph is a python package. You can install it just like any other python -package. +mlpyqtgraph is a [python package](https://pypi.org/project/mlpyqtgraph/) which +is available on the [Python Package Index (PyPi)](https://pypi.org/). You can +install it just like any other python package using `pip`: -First clone the package from GitHub using `git`: +``` bash +pip install mlpyqtgraph +``` + +Alternatively, you can install mlpyqtgraph directly from source. To do this, +first clone the package from GitHub using `git`: ```bash git clone https://github.com/swvanbuuren/mlpyqtgraph.git