diff --git a/README.md b/README.md index 564a32d8..abd5a339 100644 --- a/README.md +++ b/README.md @@ -21,32 +21,26 @@ See the [demo.ipynb](https://github.com/MIT-LCP/wfdb-python/blob/main/demo.ipynb ## Installation -The distribution is hosted on PyPI at: . The package can be directly installed from PyPI using either pip or poetry: +The distribution is hosted on PyPI at: . The package can be directly installed from PyPI using pip: ```sh pip install wfdb -poetry add wfdb ``` -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 and ). +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. The development version is hosted at: . 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: ```sh -# Without dev dependencies pip install . -poetry install +``` -# With dev dependencies -pip install ".[dev]" -poetry install -E dev +If you intend to make changes to the repository, you can install additional packages that are useful for development by running: -# Install the dependencies only -poetry install -E dev --no-root +```sh +pip install ".[dev]" ``` -**See the [note](https://github.com/MIT-LCP/wfdb-python/blob/main/DEVELOPING.md#package-and-dependency-management) about dev dependencies.** - ## Developing Please see the [DEVELOPING.md](https://github.com/MIT-LCP/wfdb-python/blob/main/DEVELOPING.md) document for contribution/development instructions.