Skip to content

Commit d3439da

Browse files
authored
README improvements (#503)
Updates and clarifications to the installation instructions in the README file.
2 parents 56b7d5c + 4b23191 commit d3439da

File tree

1 file changed

+6
-12
lines changed

1 file changed

+6
-12
lines changed

README.md

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -21,32 +21,26 @@ See the [demo.ipynb](https://github.com/MIT-LCP/wfdb-python/blob/main/demo.ipynb
2121

2222
## Installation
2323

24-
The distribution is hosted on PyPI at: <https://pypi.python.org/pypi/wfdb/>. The package can be directly installed from PyPI using either pip or poetry:
24+
The distribution is hosted on PyPI at: <https://pypi.python.org/pypi/wfdb/>. The package can be directly installed from PyPI using pip:
2525

2626
```sh
2727
pip install wfdb
28-
poetry add wfdb
2928
```
3029

31-
On Linux systems, accessing _compressed_ WFDB signal files requires installing `libsndfile`, by running `sudo apt-get install libsndfile1` or `sudo yum install libsndfile`. Support for Apple M1 systems is a work in progess (see <https://github.com/bastibe/python-soundfile/issues/310> and <https://github.com/bastibe/python-soundfile/issues/325>).
30+
On some less-common systems, you may need to install `libsndfile` separately. See the [soundfile installation notes](https://pypi.org/project/soundfile/) for more information.
3231

3332
The development version is hosted at: <https://github.com/MIT-LCP/wfdb-python>. This repository also contains demo scripts and example data. To install the development version, clone or download the repository, navigate to the base directory, and run:
3433

3534
```sh
36-
# Without dev dependencies
3735
pip install .
38-
poetry install
36+
```
3937

40-
# With dev dependencies
41-
pip install ".[dev]"
42-
poetry install -E dev
38+
If you intend to make changes to the repository, you can install additional packages that are useful for development by running:
4339

44-
# Install the dependencies only
45-
poetry install -E dev --no-root
40+
```sh
41+
pip install ".[dev]"
4642
```
4743

48-
**See the [note](https://github.com/MIT-LCP/wfdb-python/blob/main/DEVELOPING.md#package-and-dependency-management) about dev dependencies.**
49-
5044
## Developing
5145

5246
Please see the [DEVELOPING.md](https://github.com/MIT-LCP/wfdb-python/blob/main/DEVELOPING.md) document for contribution/development instructions.

0 commit comments

Comments
 (0)