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

Add windows dev info to README #3043

Merged
merged 6 commits into from
Feb 6, 2020
Merged

Add windows dev info to README #3043

merged 6 commits into from
Feb 6, 2020

Conversation

inodb
Copy link
Member

@inodb inodb commented Feb 6, 2020

Based on @ecerami's experiences

README.md Outdated
@@ -19,6 +19,8 @@ Make sure you have installed the node version and yarn version specified in

**Tip:** You might want to use [nvm: Node Version Manager](https://github.com/nvm-sh/nvm) and [yvm: Yarn Version Manager](https://yvm.js.org/docs/overview) to switch between versions more easily.

**Tip:** There are some known hiccups running the frontend on Windows see [run on Windows section](#Run-on-Windows)
Copy link
Contributor

Choose a reason for hiding this comment

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

The hiccups are are actually only related to running the tests, and also only related to Ubuntu running in Windows via WSL. Suggest that we move the this text to the test section, and modify to say: There are some known hiccups running the frontend tests on Ubuntu via Windows Subsystem for Linux (WSL). For details, see run on WSL section

README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@ecerami ecerami 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 doing this @inodb!
I left a few small suggestions in the comments.

@inodb
Copy link
Member Author

inodb commented Feb 6, 2020

Thanks for reviewing @ecerami - changed it to a single line in the test section

@inodb inodb requested a review from ecerami February 6, 2020 20:06
Copy link
Contributor

@ecerami ecerami left a comment

Choose a reason for hiding this comment

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

Approved!

@inodb inodb merged commit 1c50812 into master Feb 6, 2020
@inodb inodb deleted the add-windows-info-to-readme branch April 24, 2020 12:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants