mirror of
https://github.com/fish-shell/fish-shell
synced 2025-01-13 13:39:02 +00:00
Replaced README with README.md for github
Changed 'root' Xcode target to 'install_tree' to avoid confusion
This commit is contained in:
parent
00fcd63b88
commit
3a940781d9
3 changed files with 44 additions and 20 deletions
|
@ -7,9 +7,9 @@
|
||||||
objects = {
|
objects = {
|
||||||
|
|
||||||
/* Begin PBXAggregateTarget section */
|
/* Begin PBXAggregateTarget section */
|
||||||
D07D265615E33B86009E43F6 /* root */ = {
|
D07D265615E33B86009E43F6 /* install_tree */ = {
|
||||||
isa = PBXAggregateTarget;
|
isa = PBXAggregateTarget;
|
||||||
buildConfigurationList = D07D266F15E33B86009E43F6 /* Build configuration list for PBXAggregateTarget "root" */;
|
buildConfigurationList = D07D266F15E33B86009E43F6 /* Build configuration list for PBXAggregateTarget "install_tree" */;
|
||||||
buildPhases = (
|
buildPhases = (
|
||||||
D07D266915E33B86009E43F6 /* CopyFiles */,
|
D07D266915E33B86009E43F6 /* CopyFiles */,
|
||||||
D07D266B15E33B86009E43F6 /* Copy Files */,
|
D07D266B15E33B86009E43F6 /* Copy Files */,
|
||||||
|
@ -21,7 +21,7 @@
|
||||||
D07D265D15E33B86009E43F6 /* PBXTargetDependency */,
|
D07D265D15E33B86009E43F6 /* PBXTargetDependency */,
|
||||||
D07D265F15E33B86009E43F6 /* PBXTargetDependency */,
|
D07D265F15E33B86009E43F6 /* PBXTargetDependency */,
|
||||||
);
|
);
|
||||||
name = root;
|
name = install_tree;
|
||||||
productName = base;
|
productName = base;
|
||||||
};
|
};
|
||||||
D0F019EC15A976F30034B3B1 /* base */ = {
|
D0F019EC15A976F30034B3B1 /* base */ = {
|
||||||
|
@ -814,7 +814,7 @@
|
||||||
projectRoot = "";
|
projectRoot = "";
|
||||||
targets = (
|
targets = (
|
||||||
D0F019EC15A976F30034B3B1 /* base */,
|
D0F019EC15A976F30034B3B1 /* base */,
|
||||||
D07D265615E33B86009E43F6 /* root */,
|
D07D265615E33B86009E43F6 /* install_tree */,
|
||||||
D0D02A9915985A75008E62BD /* fish.app */,
|
D0D02A9915985A75008E62BD /* fish.app */,
|
||||||
D0D2693B159835CA005D9B9C /* fish_shell */,
|
D0D2693B159835CA005D9B9C /* fish_shell */,
|
||||||
D0D02ABB15985EF9008E62BD /* fishd */,
|
D0D02ABB15985EF9008E62BD /* fishd */,
|
||||||
|
@ -1317,7 +1317,7 @@
|
||||||
/* End XCBuildConfiguration section */
|
/* End XCBuildConfiguration section */
|
||||||
|
|
||||||
/* Begin XCConfigurationList section */
|
/* Begin XCConfigurationList section */
|
||||||
D07D266F15E33B86009E43F6 /* Build configuration list for PBXAggregateTarget "root" */ = {
|
D07D266F15E33B86009E43F6 /* Build configuration list for PBXAggregateTarget "install_tree" */ = {
|
||||||
isa = XCConfigurationList;
|
isa = XCConfigurationList;
|
||||||
buildConfigurations = (
|
buildConfigurations = (
|
||||||
D07D267015E33B86009E43F6 /* Debug */,
|
D07D267015E33B86009E43F6 /* Debug */,
|
||||||
|
|
15
README
15
README
|
@ -1,15 +0,0 @@
|
||||||
How to find documentation for fish
|
|
||||||
==================================
|
|
||||||
|
|
||||||
The fish documentation is distributed in an intermediate format. To
|
|
||||||
view it, you have to type:
|
|
||||||
|
|
||||||
% make user_doc
|
|
||||||
|
|
||||||
Which will create the directory user_doc, containing html
|
|
||||||
documentation for fish. If you build and install fish, the
|
|
||||||
documentation will be available through the 'help' builtin.
|
|
||||||
|
|
||||||
After installation, you can start fish by typing fish in the
|
|
||||||
terminal. After fish has started, try using the help command for more
|
|
||||||
information.
|
|
39
README.md
Normal file
39
README.md
Normal file
|
@ -0,0 +1,39 @@
|
||||||
|
[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/FishsFish/Build/Products/Debug/base/bin/fish`
|
||||||
|
|
||||||
|
### Xcode Build and Install
|
||||||
|
|
||||||
|
mkdir /tmp/fish_build
|
||||||
|
xcodebuild install -target install_tree DSTROOT=/tmp/fish_build
|
||||||
|
sudo ditto /tmp/fish_build/ /
|
||||||
|
|
||||||
|
## 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.
|
Loading…
Reference in a new issue