diff --git a/docs/README.md b/docs/README.md index 5d0da583..f3d31a14 100644 --- a/docs/README.md +++ b/docs/README.md @@ -42,27 +42,6 @@ Stop polluting your `~/bin` directory and your `.bashrc` file, fork/clone Bash-i ``git clone --depth=1 https://github.com/Bash-it/bash-it.git ~/.bash_it`` 2) Run ``~/.bash_it/install.sh`` -### Bash Dependency - -Bash-it requires Bash 4.?? or later to run correctly. Any reasonably current Linux distribution should have shipped with a compatible version of Bash. However, macOS users must upgrade from the included, obsolete Bash version 3. While some functionality might work with Bash 3, there is no guarantee that everything will work perfectly. Thus, we recommend using [Homebrew](https://brew.sh/) to ensure Bash is up to date: - -**x86 Mac** - -```bash -$ brew install bash -$ sudo sh -c 'echo /usr/local/bin/bash >> /etc/shells' -$ chsh -s /usr/local/bin/bash -``` - -**M1 Mac** -Homebrew's default installation location on M1 is ``/opt/homebrew/bin/``: - -```bash -$ brew install bash -$ sudo sh -c 'echo /opt/homebrew/bin/bash >> /etc/shells' -$ chsh -s /opt/homebrew/bin/bash -``` - That's it! :smiley: You can check out more components of Bash-it, and customize it to your desire. diff --git a/docs/troubleshooting.rst b/docs/troubleshooting.rst index 6503699a..953a129a 100644 --- a/docs/troubleshooting.rst +++ b/docs/troubleshooting.rst @@ -8,9 +8,30 @@ Table of Contents * `I'm stuck in the LightDM login screen after setting up bash-it. `_ +* `I'm getting strange line break and wrapping behaviour on macOS. `_ + I'm stuck in the LightDM login screen after setting up bash-it ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ **Possible issue**\ : `#672 `_ **Solution**\ : Check `this comment `_ for detailed information about the cause and solution for this issue. + +I'm getting strange line break and wrapping behaviour on macOS +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +**Possible issue**\ : `#1614 `_ + +**Solution**\ : Bash-it requires Bash 4.?? or later to run correctly. Any reasonably current Linux distribution should have shipped with a compatible version of Bash. However, macOS users must upgrade from the included, obsolete Bash version 3. While some functionality might work with Bash 3, there is no guarantee that everything will work perfectly. Thus, we recommend using `Homebrew `_ to ensure Bash is up to date: + +**x86 Mac:**\ +.. code-block:: console + $ brew install bash + $ sudo sh -c 'echo /usr/local/bin/bash >> /etc/shells' + $ chsh -s /usr/local/bin/bash + +**M1 Mac:**\ Homebrew's default installation location on M1 is ``/opt/homebrew/bin/``: +.. code-block:: console + $ brew install bash + $ sudo sh -c 'echo /opt/homebrew/bin/bash >> /etc/shells' + $ chsh -s /opt/homebrew/bin/bash