From 52c4896ea9f32da77fb5510ab5721b4916fc2900 Mon Sep 17 00:00:00 2001 From: Bruno Date: Sat, 30 May 2015 12:03:12 +0100 Subject: [PATCH] Update documentation --- README.md | 16 ++++------------ 1 file changed, 4 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index f1b8c8a..a840e34 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ | Usage | -Contribute +Contributing | Uninstall | @@ -52,9 +52,7 @@ If you want to install it manually, [keep reading](#manual-installation). ## Usage -Enabling a new plugin or theme is as easy as it should be. Open your fish configuration file `~/.config/fish/config.fish` and specify the theme and the plugins you want to use. - -As an example, to enable rails and git-flow plugins add this line `set fish_plugins git-flow rails` to your configuration file. +Open your fish configuration file `~/.config/fish/config.fish` and specify the theme and the plugins you want to use. And then run `fish install` on your terminal to install them. Before setting down on a theme, you might want to have a go with all themes using our quick [theme switcher](https://github.com/bpinto/oh-my-fish/blob/master/plugins/theme/README.md) by typing `theme --help` on your shell. @@ -63,21 +61,15 @@ Before setting down on a theme, you might want to have a go with all themes usin If you have many functions which go well together, you can create custom plugin in the `custom/plugins/PLUGIN_NAME` directory and add to it as many functions as you want. -If you would like to override the functionality of a plugin distributed with oh-my-fish, -create a plugin of the same name in the `custom/plugins/` directory and it will be loaded -instead of the one shipped with oh-my-fish. - If you would like to use your custom theme, move it with the same name in the `custom/themes/` directory and it will override the original theme in `themes/`. If you just want to override any of the default behavior or add some environment variables, just add a new file (ending in .load) into the `custom/` directory. -## Send us your theme! +## Contributing -We are hoping to collect a bunch of themes for our command prompts. You can see existing ones in the [themes](themes/) directory. - -> __Note__: Theme authors, make sure to include a screenshot in your pull request. +Create an [issue](https://github.com/bpinto/oh-my-fish/issues) linking to your repository and we will move it to the [oh-my-fish](https://github.com/oh-my-fish) organization. ### Manual installation