Archives
/
oh-my-fish
mirror of https://github.com/oh-my-fish/oh-my-fish
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Updating readme content and migrated to markdown.

Browse Source
pull/2/head
Bruno 11 years ago
parent 192e4e4a4d
commit cff8a47d15
2 changed files with 82 additions and 78 deletions
Show Stats Download Patch File Download Diff File

82
README.markdown
Unescape Escape View File

@ -0,0 +1,82 @@
# Oh My Fish!
### Why?
Developing on a shell should be a pleasure. Our goal is to help developers that don't want to spend time configuring their own computer to spend time doing what they want.
### How?
With the power of our community, we take the already awesome [fish shell][fish] to another level by creating simple-to-use plugins and themes.
[fish]: http://fishshell.com/
### What?
A user-friendly framework for managing your fish-shell configuration. Includes optional plugins (brew, git, rails, python, node, etc) and themes.
A handful of functions, auto-complete helpers, and stuff that makes you shout...
## Installation
Oh-my-fish is built for recent versions of the fish shell, namely "fish 2.0".
wget --no-check-certificate https://github.com/bpinto/oh-my-fish/raw/master/tools/install.sh -O - | sh
If you want to install it manually, keep reading.
## 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, enabling rails and git plugins is as easy as adding this line `set fish_plugins git rails`
to your configuration file.
## Customization
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 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!
I'm hoping to collect a bunch of themes for our command prompts. You can see existing ones in the `themes/` directory.
## Switching to fish
If you wish to use fish as your default shell, use the following command:
grep -q '^/usr/local/bin/fish$' /etc/shells; or echo '/usr/local/bin/fish' | sudo tee -a /etc/shells
chsh -s /usr/local/bin/fish
chsh will prompt you for your password, and change your default shell.
To switch your default shell back, you can run:
chsh -s /bin/bash
Substitute /bin/bash with /bin/tcsh or /bin/zsh as appropriate.
### Manual installation
1. Clone the repository
git clone git://github.com/bpinto/oh-my-fish.git ~/.oh-my-fish
2. Create a new fish config by copying the fish template we've provided.
cp ~/.oh-my-fish/templates/config.fish ~/.config/fish/config.fish
3. Start / restart fish (just open a new terminal)
##. Oh My ZSH
This project is heavily inspired by "oh-my-zsh":https://github.com/robbyrussell/oh-my-zsh/
Thank you so much!

78
README.textile
Unescape Escape View File

@ -1,78 +0,0 @@
A handful of functions, auto-complete helpers, and stuff that makes you shout...
bq. "OH MY FISH!"
h2. Setup
@oh-my-fish@ should work with any release from "fish 2.0":http://ridiculousfish.com/shell/
h3. The automatic installer... (do you trust me?)
You can install this via the command line with either `curl` or `wget`.
h4. via `curl`
@curl -L https://github.com/bpinto/oh-my-fish/raw/master/tools/install.sh | sh@
h4. via `wget`
@wget --no-check-certificate https://github.com/bpinto/oh-my-fish/raw/master/tools/install.sh -O - | sh@
h3. The manual way
1. Clone the repository
@git clone git://github.com/bpinto/oh-my-fish.git ~/.oh-my-fish@
2. Create a new fish config by copying the fish template we've provided.
*NOTE*: If you already have a ~/.config/fish/config.fish file, you should back it up: @cp ~/.config/fish/config.{fish,orig}@ in case you want to go back to your original settings.
@cp ~/.oh-my-fish/templates/config.fish ~/.config/fish/config.fish@
3. Start / restart fish (open a new terminal is easy enough...)
h3. Set fish as your default shell
1. Add fish to the list of login shells
@grep -q '^/usr/local/bin/fish$' /etc/shells; or echo '/usr/local/bin/fish' | sudo tee -a /etc/shells@
2. Set fish as default shell
@chsh -s /usr/local/bin/fish@
h2. Usage
* enable the plugins you want in your @~/.config/fish/config.fish@ (take a look at @plugins/@ to see what's possible)
** example: @set fish_plugins autojump bundler@
* Theme support: Change the @fish_theme@ environment variable in @~/.config/fish/config.fish@.
h3. Customization
If you want to override any of the default behavior, just add a new file (ending in @.load@) into the @custom/@ directory.
If you have many functions which go well together you can put them as a *.fish file in the @custom/plugins/@ directory and then enable this plugin.
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 in @plugins/@.
h3. Uninstalling
If you want to uninstall it, just remove the installation folder @rm -r ~/.oh-my-fish@ from the command line and restore your previous fish config file.
h2. Help out!
I'm far from being a fish-expert and suspect there are many ways to improve. If you have ideas on how to make the configuration easier to maintain (and faster), don't hesitate to fork and send pull requests!
h3. Send us your theme!
I'm hoping to collect a bunch of themes for our command prompts. You can see existing ones in the @themes/@ directory.
h2. Oh My ZSH
This project is heavily inspired (cloned) on "oh-my-zsh":https://github.com/robbyrussell/oh-my-zsh/
Thank you so much!
Write Preview
Loading…
Cancel
Save