Skip to content

Commit

Permalink
add --no-modify-config description in README
Browse files Browse the repository at this point in the history
  • Loading branch information
knorth55 committed Nov 4, 2016
1 parent 16fd12a commit db4449d
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,12 @@ The install script can take the following options:

* `--interactive`: Asks the user which aliases, completions and plugins to enable.

* `--no-modify-config`: Do not modify config file (~/.bash_profile or ~/.bashrc).

When run without the `--interactive` switch, Bash-it only enables a sane default set of functionality to keep your shell clean and to avoid issues with missing dependencies. Feel free to enable the tools you want to use after the installation.

When you run without the `--no-modify-config` switch, Bash-it installation automatically modify your existing config file.

**NOTE**: Keep in mind how Bash load its configuration files, `.bash_profile` for login shells (and in Mac OS X in terminal emulators like [Terminal.app](http://www.apple.com/osx/apps/) or [iTerm2](https://www.iterm2.com/)) and `.bashrc` for interactive shells (default mode in most of the GNU/Linux terminal emulators), to ensure that Bash-it is loaded correctly. A good "practice" is sourcing `.bashrc` into `.bash_profile` to keep things working in all the scenarios, to achieve this, you can add this snippet in your `.bash_profile`:

```
Expand Down

0 comments on commit db4449d

Please sign in to comment.