Join GitHub today
GitHub is home to over 40 million developers working together to host and review code, manage projects, and build software together.Sign up
Remove direct installation instructions, link to docs #2642
Change default installation instructions to remove use of "sudo", as it is highly discouraged.
Other very popular packages also refraining from using "sudo" in their documentation:
Edit: PR changed according to feedback.
If you're using a user-environment Python like from
If there's a danger that people might just do
The install instructions on the repo's README are a remnant of the Livestreamer fork, I believe. Streamlink's documentation has a dedicated install page, where the
Not sure if everyone else agrees with me here, but I think it would be better to remove the install commands from the README as a whole and just refer to the install documentation instead. Ideally, this should have been done when the the install page and Github release template got rewritten earlier this year, but I forgot about it.
I won't close any PRs this month due to Hacktoberfest, but if we agree on removing the commands, I would be happy if you could change this PR real quick. If not, then just removing the sudo part is also fine.
@@ Coverage Diff @@ ## master #2642 +/- ## ========================================== + Coverage 52.45% 52.72% +0.26% ========================================== Files 242 242 Lines 15115 15115 ========================================== + Hits 7929 7969 +40 + Misses 7186 7146 -40