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

Improved installation section of README #608

Merged
merged 1 commit into from
Jul 13, 2020
Merged

Improved installation section of README #608

merged 1 commit into from
Jul 13, 2020

Conversation

ashellunts
Copy link
Contributor

Removed obsolete link to wiki (does it still exist somewhere?) . Also added virtualenv commands because otherwise 'python setup.py develop' fails.

For me as a beginner it was confusing why 'python setup.py develop' fails when I followed instructions. With this change, installation process for a new contributer should go smoother :)

@coveralls
Copy link

coveralls commented Jun 14, 2020

Coverage Status

Coverage remained the same at 92.867% when pulling c47eb56 on ashellunts:fix_docs into 66d439b on mozilla:master.

Copy link
Contributor

@whimboo whimboo left a comment

Choose a reason for hiding this comment

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

Thank you for your contribution, and sorry if it's hard to understand at the moment.

Instead of duplicating instructions I would be more in favor of just referencing a page that explains all the details. And what's better than the python guide website for virtualenv.

README.md Outdated Show resolved Hide resolved
Added link to virtualenv guide. Also removed obsolete link to wiki.
@ashellunts ashellunts requested a review from whimboo July 10, 2020 22:01
@whimboo
Copy link
Contributor

whimboo commented Jul 13, 2020

Thanks a lot for your patch. This looks fine now, and I will get it merged immediately.

@whimboo whimboo merged commit d62c75b into mozilla:master Jul 13, 2020
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.

3 participants