From 338a981cdbfe4c8da723f6600abb810220f70188 Mon Sep 17 00:00:00 2001 From: Jean-Christophe Morin Date: Sat, 17 Feb 2024 15:45:50 -0500 Subject: [PATCH 1/5] Improve install docs by mentioning how to actually download rez. Signed-off-by: Jean-Christophe Morin --- docs/source/installation.rst | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/source/installation.rst b/docs/source/installation.rst index 2dc049f62..818af55b4 100644 --- a/docs/source/installation.rst +++ b/docs/source/installation.rst @@ -8,12 +8,15 @@ Installation Script .. warning:: The install script only supports Python 3.7+. -To install rez, download the source. Then from the root directory, run:: +To install rez, download the source by either cloning the `repository `_ +with git or downloading it from the `latest release `_. +If you download rez from the release page on GitHub, don't forget to unpack the downloaded archive. + +Then from the root directory, run:: ]$ python ./install.py -This installs rez to ``/opt/rez``. See ```install.py -h``` for how to install to a -different location. +This installs rez to ``/opt/rez``. See ``install.py -h`` to see the different install options. Once the installation is complete, a message tells you how to run it:: From 735dc4eb7e0e3c1995804509ce71b56077301891 Mon Sep 17 00:00:00 2001 From: Jean-Christophe Morin Date: Sat, 17 Feb 2024 15:49:48 -0500 Subject: [PATCH 2/5] Remove duplicated "see" Signed-off-by: Jean-Christophe Morin --- docs/source/installation.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/installation.rst b/docs/source/installation.rst index 818af55b4..f798144f1 100644 --- a/docs/source/installation.rst +++ b/docs/source/installation.rst @@ -16,7 +16,7 @@ Then from the root directory, run:: ]$ python ./install.py -This installs rez to ``/opt/rez``. See ``install.py -h`` to see the different install options. +This installs rez to ``/opt/rez``. Use ``install.py -h`` to see the different install options. Once the installation is complete, a message tells you how to run it:: From 3b09f193748a05e0d1ea40cd95ed1fe4ff48cdf8 Mon Sep 17 00:00:00 2001 From: Jean-Christophe Morin Date: Sat, 17 Feb 2024 15:51:11 -0500 Subject: [PATCH 3/5] Remove warning about python 3.7+ Signed-off-by: Jean-Christophe Morin --- docs/source/installation.rst | 3 --- 1 file changed, 3 deletions(-) diff --git a/docs/source/installation.rst b/docs/source/installation.rst index f798144f1..b7ba4d20b 100644 --- a/docs/source/installation.rst +++ b/docs/source/installation.rst @@ -5,9 +5,6 @@ Installation Installation Script =================== -.. warning:: - The install script only supports Python 3.7+. - To install rez, download the source by either cloning the `repository `_ with git or downloading it from the `latest release `_. If you download rez from the release page on GitHub, don't forget to unpack the downloaded archive. From e59a59329d74666fd0b5ce1229f41c1dde9ba1a6 Mon Sep 17 00:00:00 2001 From: Jean-Christophe Morin Date: Mon, 19 Feb 2024 19:17:35 -0500 Subject: [PATCH 4/5] Adjust based on feedback. Signed-off-by: Jean-Christophe Morin --- docs/source/installation.rst | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/docs/source/installation.rst b/docs/source/installation.rst index b7ba4d20b..5bed77bee 100644 --- a/docs/source/installation.rst +++ b/docs/source/installation.rst @@ -5,9 +5,14 @@ Installation Installation Script =================== -To install rez, download the source by either cloning the `repository `_ -with git or downloading it from the `latest release `_. -If you download rez from the release page on GitHub, don't forget to unpack the downloaded archive. +To install rez, you will need: + +1. Python 3.7 or above. We support 3.7, 3.8, 3.9, 3.10 and 3.11. + The pythoon interpreter you use to run the install script will be the interpreter + used by rez itself. +2. The source code. You can get it by either cloning the `repository `_ + with git or downloading it from the `latest release `_. + If you download rez from the release page on GitHub, don't forget to unpack the downloaded archive. Then from the root directory, run:: From d5437745a983300ce90dab063ada5305b4b37b20 Mon Sep 17 00:00:00 2001 From: Jean-Christophe Morin <38703886+JeanChristopheMorinPerso@users.noreply.github.com> Date: Tue, 20 Feb 2024 19:11:55 -0500 Subject: [PATCH 5/5] Fix rypo Signed-off-by: Jean-Christophe Morin <38703886+JeanChristopheMorinPerso@users.noreply.github.com> --- docs/source/installation.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/installation.rst b/docs/source/installation.rst index 5bed77bee..acef065ad 100644 --- a/docs/source/installation.rst +++ b/docs/source/installation.rst @@ -8,7 +8,7 @@ Installation Script To install rez, you will need: 1. Python 3.7 or above. We support 3.7, 3.8, 3.9, 3.10 and 3.11. - The pythoon interpreter you use to run the install script will be the interpreter + The python interpreter you use to run the install script will be the interpreter used by rez itself. 2. The source code. You can get it by either cloning the `repository `_ with git or downloading it from the `latest release `_.