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

README: update installation & running details #6172

Merged
merged 5 commits into from
Sep 6, 2022

Conversation

shaunanoordin
Copy link
Member

PR Overview

This PR updates the README with additional information on how to run PFE. There were some deficiencies in information that weren't uncovered until I walked our new intern through the process of setting PFE up.

Status

Ready for review. Assigning to MaysaB, but everyone is free to jump in.

@coveralls
Copy link

coveralls commented Aug 25, 2022

Coverage Status

Coverage remained the same at 50.129% when pulling 42345b9 on update-readme-install into 6066802 on master.

README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
@MaysaB MaysaB self-requested a review August 30, 2022 13:44
@shaunanoordin
Copy link
Member Author

Thanks both for the feedback!

PR Update

  • Changed: instructions now favour npm ci instead of npm install
  • Added: section explaining why we prefer npm ci
  • Added: section on troubleshooting web browsers blocking local websites

README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@MaysaB MaysaB left a comment

Choose a reason for hiding this comment

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

LGTM!

@shaunanoordin shaunanoordin merged commit b977c8b into master Sep 6, 2022
@shaunanoordin shaunanoordin deleted the update-readme-install branch June 24, 2024 22:59
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.

4 participants