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.

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

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

Conversation

JeanChristopheMorinPerso
Copy link
Member

@JeanChristopheMorinPerso JeanChristopheMorinPerso commented Feb 17, 2024

Related to https://www.bestpractices.dev/en/projects/8389#interact.

I noticed that the docs were not very clear on how rez could be download.

Signed-off-by: Jean-Christophe Morin <jean_christophe_morin@hotmail.com>
@JeanChristopheMorinPerso JeanChristopheMorinPerso changed the title Improve install docs by mentioning how to actually download rez. Improve install docs by mentioning how to actually download rez Feb 17, 2024
Signed-off-by: Jean-Christophe Morin <jean_christophe_morin@hotmail.com>
Signed-off-by: Jean-Christophe Morin <jean_christophe_morin@hotmail.com>
@MrLixm
Copy link

MrLixm commented Feb 17, 2024

This is great !
I would also love to see, if that make sense :

  • specify explicitly that python need to be installed on the system for the python alias to work
  • the python version used with the install script determine the python version used by rez
  • which python version are preferred (more tested against I guess ?)
  • admin permissions might be required to install on the C:/ disk on Windows

@parikshittiwari740
Copy link

parikshittiwari740 commented Feb 18, 2024

I think the 2nd point of @MrLixm is quite important and should definitely be added :)

The others seem more or less obvious to me as it kinda feels like basic knowledge that you would be expected to have as a developer.

Signed-off-by: Jean-Christophe Morin <jean_christophe_morin@hotmail.com>
@JeanChristopheMorinPerso
Copy link
Member Author

Thank you @MrLixm and @parikshittiwari740! I pushed a new commit that I think addresses your feedback. Does the new changes look good to you?

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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks. I'm a professional full time typo creator.

Signed-off-by: Jean-Christophe Morin <38703886+JeanChristopheMorinPerso@users.noreply.github.com>
@JeanChristopheMorinPerso JeanChristopheMorinPerso merged commit fb02c4a into AcademySoftwareFoundation:main Feb 21, 2024
5 checks passed
@JeanChristopheMorinPerso JeanChristopheMorinPerso deleted the improve_install_docs branch February 21, 2024 00:21
@JeanChristopheMorinPerso JeanChristopheMorinPerso added this to the Next milestone Mar 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

None yet

4 participants