Added update-bash section in README

[dylanjtuttle]

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

• [X] Bug fix (non-breaking change which fixes an issue)
• [ ] New feature (non-breaking change which adds functionality)
• [ ] Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

• [X] My code follows the code style of this project.
• [X] If my change requires a change to the documentation, I have updated the documentation accordingly.
• [X] I have read the CONTRIBUTING document.
• [ ] If I have added a new file, I also added it to clean_files.txt and formatted it using lint_clean_files.sh.
• [ ] I have added tests to cover my changes, and all the new and existing tests pass.

[tbhaxor]

Hey @dylanjtuttle, can we add this in docs directory as well?

[NoahGorny]

Hi @dylanjtuttle, we use readthedocs as our proper documentation. The readme is just there for quick installation guide. You can add it to docs/troubleshooting.rst

[dylanjtuttle]

Hi @NoahGorny, I became deathly afraid of the difference in syntax between markdown and readthedocs and ignored this project for several months. It looks like I haven't gotten it quite right yet, but I will continue trying.