From 9e52e987ed73bf9bb76237fa0da74c9e617d6435 Mon Sep 17 00:00:00 2001 From: Reto Trappitsch Date: Tue, 23 Aug 2022 09:57:28 +0200 Subject: [PATCH] Update docs to add info on stable versions (#49) --- README.rst | 3 ++- docs/gui/install.rst | 6 ++++++ 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 1e6e42a..d68002f 100644 --- a/README.rst +++ b/README.rst @@ -40,7 +40,8 @@ Package installation pip install rimseval -Add ``--pre`` flag for pre-releases or install the latest version from GitHub. +If pre-releases are available and you would like to install one, +add the ``--pre`` flag to above command. More information in the `documentation `_. diff --git a/docs/gui/install.rst b/docs/gui/install.rst index 4b804c7..1a0c1d4 100644 --- a/docs/gui/install.rst +++ b/docs/gui/install.rst @@ -164,6 +164,12 @@ you can simply type: git pull git install -r requirements.txt --upgrade +.. note:: Newer versions of the GUI can depend on development versions + of ``rimseval``. This means that you might see unexpected and wrong behavior. + The packaging tool of the GUI does not allow for specifically labeling of such versions. + Therefore, it is up to he user to ensure that you have the version that you like. + New versions that depend on development versions of ``rimseval`` will always be labeled + on GitHub as pre-releases. They will therefore not show up in the update reminder of the software. ------ Python