From 7857e096cd59c3ef5f34273125aa919ec44f3b17 Mon Sep 17 00:00:00 2001 From: Umberto Lupo <46537483+ulupo@users.noreply.github.com> Date: Mon, 20 Jan 2020 11:01:35 +0100 Subject: [PATCH] Add recommendations to upgrade pip and/or setuptools in README (#192) * Add recommendations to upgrade pip and/or setuptools in README Following (#136), this adds a little more guidance for users who might experience installation woes. Note that in our azure pipelines, we ourselves upgrade pip and setuptools before testing installation from source. --- README.rst | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 641a8c51b..1c5f31d3e 100644 --- a/README.rst +++ b/README.rst @@ -65,6 +65,9 @@ The simplest way to install giotto-learn is using ``pip`` :: pip install -U giotto-learn +Note: the above may fail on old versions of ``pip``. We recommend upgrading ``pip`` +to a recent version. + Pre-release, experimental builds containing recently added features and/or bug fixes can be installed by running :: @@ -144,7 +147,8 @@ To install: cd giotto-learn pip install -e ".[tests, doc]" -From there any change in the library files will be immediately available on your machine. +This way, you can pull the library's latest changes and make them immediately available on your machine. +Note: we recommend upgrading ``pip`` and ``setuptools`` to recent versions before installing in this way. Testing ~~~~~~~