Skip to content

Commit

Permalink
Add README
Browse files Browse the repository at this point in the history
  • Loading branch information
ctcherry committed Aug 20, 2011
1 parent a87e346 commit 12f2ddb
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions README.md
@@ -0,0 +1,29 @@
bash_plugins
============

*Experimental*

An extensible system to organize bash customizations into plugins.


Install
-------

- Clone repository into `~/.bash_plugins`
- Add `source .bash_plugins/init.sh` to `.bashrc`


Activate a plugin
-----------------
Create a symlink at `~/.bash_plugins/enabled_plugins/PLUGIN_NAME` pointing to `~/.bash_plugins/available_plugins/PLUGIN_NAME`

Example:

$ cd ~/.bash_plugins/enabled_plugins
$ ln -s ../available_plugins/lastdir .


How to contribute a new plugin or changes
-----------------------------------------

Create Github fork and issue pull request.

0 comments on commit 12f2ddb

Please sign in to comment.