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

Improve readme clarity and troubleshooting for install script #2125

Merged
merged 2 commits into from Jan 1, 2020

Conversation

@nebbles
Copy link
Contributor

nebbles commented Nov 17, 2019

  • Clean up readme structure a bit to help with readability.
  • Fix instructions which could lead to a sourcing loop if misinterpreted.
  • Guidance should direct macos users to simply copy the source snippet manually into their desired profile file.

Resolve #2123

Clean up readme structure a bit to help with readability. fix
instructions which could lead to a sourcing loop if misinterpreted.
guidance should direct macos users to simply copy the source snippet
manually into their desired profile file.

Resolve #2123
Copy link
Member

ljharb left a comment

Thanks!

README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
nebbles added a commit to nebbles/nvm that referenced this pull request Dec 28, 2019
Headings now conform to title case for the first three levels. Level 4
does not conform to title case. Made some corrections as suggested.

Included changes recommended in nvm-sh#2125
@nebbles nebbles requested a review from ljharb Dec 28, 2019
@nebbles

This comment has been minimized.

Copy link
Contributor Author

nebbles commented Dec 28, 2019

I have also noticed that this PR resolves #2130 (it is redundant)

@nebbles

This comment has been minimized.

Copy link
Contributor Author

nebbles commented Dec 29, 2019

I have just fixed issue with tests failing. Was due to some trailing whitespace. Might be worth taking a look at https://pre-commit.com if you're interested.

@ljharb ljharb force-pushed the nebbles:master branch 2 times, most recently from 6392ab4 to d8785da Jan 1, 2020
@ljharb
ljharb approved these changes Jan 1, 2020
@ljharb ljharb merged commit d8785da into nvm-sh:master Jan 1, 2020
1 check passed
1 check passed
continuous-integration/travis-ci/pr The Travis CI build passed
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants
You can’t perform that action at this time.