Merge pull request #9 from embark-framework/doco-update

Update documentation for macOS users to upgrade to bash v4
This commit is contained in:
Iuri Matias 2018-09-23 11:43:38 -04:00 committed by GitHub
commit 32fd8ba021
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 18 additions and 0 deletions

View File

@ -13,6 +13,8 @@ run_embark
Note that the `run_embark demo` command will create an `embark_demo` directory in
the docker host's `$PWD`.
Note if you're a macOS user and see `ERROR: this script requires Bash version >= 4.0`, please follow our [Bash upgrade instructions](./macOS-bash4-upgragde.md).
## Usage via `run.sh`
[`run.sh`](https://github.com/embark-framework/embark-docker/blob/master/run.sh)

16
macOS-bash4-upgragde.md Normal file
View File

@ -0,0 +1,16 @@
# macOS Bash v4 Upgrade Instructions
When using the `run_embark <cmd>` commands, you receive the error `ERROR: this script requires Bash version >= 4.0` on macOS, follow the steps below to upgrade bash to v4:
1. Install HomeBrew (if not already installed):
`ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"`
2. Update HomeBrew packet database and install bash:
`brew update && brew install bash`
3. Change your application to use the correct shell. For example, in Terminal, open Preferences, then change *Shells open with:* to `/usr/local/bin/bash`:
![Terminal preferences](https://i.imgur.com/vDWQfO7.png)
In iTerm2, change *Preferences > Profiles > (Select profile) > General > Command > Command* to `/usr/local/bin/bash`:
![iTerm2 preferences](https://i.imgur.com/zUZE663.png)
4. `bash --version` should show version 4+:
`$ bash --version`
`GNU bash, version 4.4.23(1)-release (x86_64-apple-darwin17.5.0)
Copyright (C) 2016 Free Software Foundation, Inc.
License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>`
5. There is a [guide to upgrading to bash 4 in macOS](http://clubmate.fi/upgrade-to-bash-4-in-mac-os-x/) if you need more help.