Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve install docs by mentioning how to actually download rez #1660

Merged
merged 5 commits into from
Feb 21, 2024
Merged

Improve install docs by mentioning how to actually download rez #1660

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
338a981
Improve install docs by mentioning how to actually download rez.
JeanChristopheMorinPerso Feb 17, 2024
735dc4e
Remove duplicated "see"
JeanChristopheMorinPerso Feb 17, 2024
3b09f19
Remove warning about python 3.7+
JeanChristopheMorinPerso Feb 17, 2024
e59a593
Adjust based on feedback.
JeanChristopheMorinPerso Feb 20, 2024
d543774
Fix rypo
JeanChristopheMorinPerso Feb 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 10 additions & 5 deletions docs/source/installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,20 @@ Installation
Installation Script
===================

.. warning::
The install script only supports Python 3.7+.
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 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 <https://github.com/AcademySoftwareFoundation/rez>`_
with git or downloading it from the `latest release <https://github.com/AcademySoftwareFoundation/rez/releases/latest>`_.
If you download rez from the release page on GitHub, don't forget to unpack the downloaded archive.

To install rez, download the source. Then from the root directory, run::
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``. Use ``install.py -h`` to see the different install options.

Once the installation is complete, a message tells you how to run it::

Expand Down