fish-shell/README.md

[fish](http://ridiculousfish.com/shell/) - the friendly interactive shell
================================================

fish is a smart and user-friendly command line shell for OS X, Linux, and the rest of the family. fish includes features like syntax highlighting, autosuggest-as-you-type, and fancy tab completions that just work, with no configuration required.

For more on fish's design philosophy, see the [design document](http://ridiculousfish.com/shell/user_doc/html/design.html).

## Quick Start

fish generally works like other shells, like bash or zsh. A few important differences are documented at <http://ridiculousfish.com/shell/faq.html>

Detailed user documentation is available by running `help` within fish, and also at <http://ridiculousfish.com/shell/user_doc/html/>

## Building

fish can be built using autotools or Xcode.

### Autotools Build

    autoconf
    ./configure [--without-xsel]
    make [gmake on BSD]
    sudo make install

### Xcode Development Build

* Build the `base` target in Xcode
* Run the fish executable, for example, in `DerivedData/fish/Build/Products/Debug/base/bin/fish`

### Xcode Build and Install

    xcodebuild install
    sudo ditto /tmp/fish.dst /

## Packages for Linux

Nightly builds for several Linux distros can be downloaded from <http://download.opensuse.org/repositories/home:/siteshwar/>

## Contact Us

Questions, comments, rants and raves can be posted to the official fish mailing list at <https://lists.sourceforge.net/lists/listinfo/fish-users>
Found a bug? Have an awesome idea? Please open an issue on this github page.
Replaced README with README.md for github Changed 'root' Xcode target to 'install_tree' to avoid confusion 2012-08-21 09:08:49 +00:00			`[fish](http://ridiculousfish.com/shell/) - the friendly interactive shell`
			`================================================`

			`fish is a smart and user-friendly command line shell for OS X, Linux, and the rest of the family. fish includes features like syntax highlighting, autosuggest-as-you-type, and fancy tab completions that just work, with no configuration required.`

			`For more on fish's design philosophy, see the [design document](http://ridiculousfish.com/shell/user_doc/html/design.html).`

			`## Quick Start`

			`fish generally works like other shells, like bash or zsh. A few important differences are documented at <http://ridiculousfish.com/shell/faq.html>`

			Detailed user documentation is available by running `help` within fish, and also at <http://ridiculousfish.com/shell/user_doc/html/>

			`## Building`

Allow setting the prompt from web_config 2012-09-06 08:30:26 +00:00			`fish can be built using autotools or Xcode.`
Replaced README with README.md for github Changed 'root' Xcode target to 'install_tree' to avoid confusion 2012-08-21 09:08:49 +00:00
			`### Autotools Build`

			`autoconf`
			`./configure [--without-xsel]`
			`make [gmake on BSD]`
			`sudo make install`

			`### Xcode Development Build`

			* Build the `base` target in Xcode
Update OS X build instructions 2012-12-27 05:30:03 +00:00			* Run the fish executable, for example, in `DerivedData/fish/Build/Products/Debug/base/bin/fish`
Replaced README with README.md for github Changed 'root' Xcode target to 'install_tree' to avoid confusion 2012-08-21 09:08:49 +00:00
			`### Xcode Build and Install`

Fix to xcodebuild https://github.com/fish-shell/fish-shell/issues/229 2012-12-01 21:28:30 +00:00			`xcodebuild install`
			`sudo ditto /tmp/fish.dst /`
Replaced README with README.md for github Changed 'root' Xcode target to 'install_tree' to avoid confusion 2012-08-21 09:08:49 +00:00
Added reference to packages built on OBS repository in README.md 2013-01-20 07:42:10 +00:00			`## Packages for Linux`

			`Nightly builds for several Linux distros can be downloaded from <http://download.opensuse.org/repositories/home:/siteshwar/>`

Replaced README with README.md for github Changed 'root' Xcode target to 'install_tree' to avoid confusion 2012-08-21 09:08:49 +00:00			`## Contact Us`

			`Questions, comments, rants and raves can be posted to the official fish mailing list at <https://lists.sourceforge.net/lists/listinfo/fish-users>`
			`Found a bug? Have an awesome idea? Please open an issue on this github page.`