Added update-bash section in README #2146
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Included a subsection under the Installation instructions in the README, giving MacOS users instructions on how to update their version of Bash so as to properly enjoy the full functionality of Bash-it.
It is worth noting that while trying to follow the instructions suggested by davesteinberg in issue #1614, I noticed that Homebrew did not install Bash to
/usr/local/bin/bash
, but rather to/opt/homebrew/bin/bash
. As it turns out, M1 Macs have changed Homebrew's default installation path to/opt/homebrew/bin/
. Therefore, I altered the suggested instructions slightly to include two sets of instructions, one for x86 Mac users, and one for M1 Mac users, which reflect this discrepancy.Motivation and Context
As noted by issue #1614, MacOS users may run into strange line break/wrap issues originating from the outdated version of Bash installed by default on Mac. This pull request adds some additional information to the installation section of the README, giving MacOS users some help with updating their version of Bash so they can avoid the issues identified in the above issue.
How Has This Been Tested?
Since this pull request solely affects documentation, it does not have any effect on the execution of the source code. Thus, I simply ran the test suite and noted that none of the tests had failed due to changes I made.
Screenshots (if appropriate):
Types of changes
Checklist:
clean_files.txt
and formatted it usinglint_clean_files.sh
.