Merge pull request #3 from erichs/enable-disable-aliases-completions

readme update
pull/139/head
nwinkler 2012-05-24 00:27:49 -07:00
commit ce936e0513
1 changed files with 9 additions and 8 deletions

View File

@ -1,6 +1,6 @@
# Bash it
**Bash it** is a mash up of my own bash commands and scripts, other bash stuff I have found.
**Bash it** is a mash up of my own bash commands and scripts, other bash stuff I have found.
(And a shameless ripoff of [oh-my-zsh](https://github.com/robbyrussell/oh-my-zsh). :)
@ -13,18 +13,19 @@ Includes autocompletion, themes, aliases, custom functions, a few stolen pieces
3. Edit your `~/.bash_profile` file in order to customize bash-it.
**NOTE:**
The install script will also prompt you asking if you use [Jekyll](https://github.com/mojombo/jekyll).
The install script will also prompt you asking if you use [Jekyll](https://github.com/mojombo/jekyll).
This is to set up the `.jekyllconfig` file, which stores info necessary to use the Jekyll plugin.
## Help Screens
```
bash-it (will show all the help commands)
aliases-help
rails-help
git-help
plugins-help
bash-it show aliases # shows installed and available aliases
bash-it show completions # shows installed and available completions
bash-it show plugins # shows installed and available plugins
bash-it help aliases # shows help for installed aliases
bash-it help completions # shows help for installed completions
bash-it help plugins # shows help for installed plugins
```
## Your Custom scripts, aliases, and functions
@ -45,7 +46,7 @@ There are a few bash it themes. If you've created your own custom prompts, I'd
I think everyone has their own custom scripts accumulated over time. And so, following in the footsteps of oh-my-zsh, bash it is a framework for easily customizing your bash shell. Everyone's got a custom toolbox, so let's start making them even better, **as a community!**
Send me a pull request and I'll merge it as long as it looks good. If you change an existing command, please give an explanation why. That will help a lot when I merge your changes in.
Send me a pull request and I'll merge it as long as it looks good. If you change an existing command, please give an explanation why. That will help a lot when I merge your changes in.
Thanks, and happing bashing!