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

Cleanup installation docs #1

Merged
merged 1 commit into from
Sep 12, 2022
Merged

Cleanup installation docs #1

merged 1 commit into from
Sep 12, 2022

Conversation

traversaro
Copy link
Contributor

In particular:

  • Specify that the installation documentation is for Ubuntu/Debian system
  • Do not install python3.8 explicitly, that would fail on Ubuntu 22.04, instead just rely on the fact that python3.* is a dependency of python3-pip and python3-venv
  • Avoid to suggest users to install in a global location. These docs are tipically followed blindly by people with not a lot of experience, and if we suggest to install in a globally visible location (be it /usr/local or ~/.local) there is an good chance that something will either do not work in mann-pytorch installation, or that mann-pytorch will break some other workflow. A good alternative is to always suggest to install in a virtual environment. Naive users will execute everything without interfering with the rest of the setup, and expert users that for any reason do not want to install in a venv they will be able to do that if they want.

Copy link
Collaborator

@paolo-viceconte paolo-viceconte left a comment

Choose a reason for hiding this comment

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

Thanks for the suggestions! I also doublechecked the updated installation procedure and it works fine on Ubuntu 20.04.

@paolo-viceconte paolo-viceconte merged commit 9e6df0b into main Sep 12, 2022
@paolo-viceconte paolo-viceconte deleted the cleanupinstall branch September 12, 2022 13:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants