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

Updated Project Description & Added Common Installation Issues #2304

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

nicholasmurillo
Copy link
Contributor

@nicholasmurillo nicholasmurillo commented Sep 25, 2024

  • Updated description of project in README
  • Added common issues during installation process in README

+ Updated description of project
+ Added common issues during installation process
@ppfeister
Copy link
Member

Some feedback regarding the common issues section ---

Item 1 is providing instructions for Linux/macOS, but the provided instruction is incorrect on tons of distributions and (all of) macOS. The provided instruction is only applicable to Debian and its derivatives. Also, with many package managers, installing versioned packages of Python (and pip) directly is often discouraged unless very specific needs require it.

Item 2 should not suggest using sudo. pip, as a tool, is meant to be userspace by default, and if a user has to run sudo, something is very wrong. Using it with sudo can lead to unexpected and undesirable results in some situations.

Item 4 (see Item 1 re versioned Python rather than using a metapackage)


Not personally a huge fan of the formatting in the top section and I would argue that common issues should be a part of the wiki or some other doc instead, to avoid clutter. Ultimately not terribly sure about this one.

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