Skip to content

Improve readme clarity and troubleshooting for install script#2125

Merged
ljharb merged 2 commits into
nvm-sh:masterfrom
nebbles:master
Jan 1, 2020
Merged

Improve readme clarity and troubleshooting for install script#2125
ljharb merged 2 commits into
nvm-sh:masterfrom
nebbles:master

Conversation

@nebbles

@nebbles nebbles commented Nov 17, 2019

Copy link
Copy Markdown
Contributor
  • 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

@ljharb ljharb left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks!

Comment thread README.md Outdated
Comment thread README.md
Comment thread README.md Outdated
Comment thread README.md Outdated
LucianBuzzo and others added 2 commits December 5, 2019 10:07
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 nvm-sh#2123
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 December 28, 2019 11:10
@nebbles

nebbles commented Dec 28, 2019

Copy link
Copy Markdown
Contributor Author

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

@nebbles

nebbles commented Dec 29, 2019

Copy link
Copy Markdown
Contributor Author

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 master branch 2 times, most recently from 6392ab4 to d8785da Compare January 1, 2020 22:08
@ljharb ljharb merged commit d8785da into nvm-sh:master Jan 1, 2020
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.

Docs: Install steps suggests source loop?

3 participants