Skip to content

Commit

Permalink
docs: Include PyPi package in installation instructions
Browse files Browse the repository at this point in the history
Signed-off-by: Sietze van Buuren <[email protected]>
  • Loading branch information
swvanbuuren committed Aug 19, 2024
1 parent d651b89 commit f514ec1
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 5 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/).

Expand Down
12 changes: 9 additions & 3 deletions docs/installation.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down

0 comments on commit f514ec1

Please sign in to comment.