mirror of
https://github.com/oh-my-fish/oh-my-fish.git
synced 2024-11-22 10:59:45 +08:00
Fix outdated project information
This commit is contained in:
parent
75cc2acc02
commit
886660d177
|
@ -30,7 +30,7 @@ If your plugin is complex, make sure to include tests, we suggest using [fish-sp
|
||||||
Make sure to include a screenshot in your pull request, but don't commit the file to git. A nifty way is too post a comment with the image and link directly to it.
|
Make sure to include a screenshot in your pull request, but don't commit the file to git. A nifty way is too post a comment with the image and link directly to it.
|
||||||
|
|
||||||
|
|
||||||
[pr]: https://github.com/bpinto/oh-my-fish/compare/
|
[pr]: https://github.com/oh-my-fish/oh-my-fish/compare/
|
||||||
[fish-spec]: https://github.com/bpinto/oh-my-fish/tree/master/plugins/fish-spec
|
[fish-spec]: https://github.com/oh-my-fish/oh-my-fish/tree/master/plugins/fish-spec
|
||||||
[commit]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
|
[commit]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
|
||||||
[style]: #style-guide
|
[style]: #style-guide
|
||||||
|
|
|
@ -5,7 +5,7 @@ RUN apt-get -y install curl git software-properties-common
|
||||||
|
|
||||||
# Set bootstrap script environment variables
|
# Set bootstrap script environment variables
|
||||||
ENV FISH_PPA=nightly-master \
|
ENV FISH_PPA=nightly-master \
|
||||||
TRAVIS_OS_NAME=linux TRAVIS_REPO_SLUG=bpinto/oh-my-fish TRAVIS_BRANCH=master
|
TRAVIS_OS_NAME=linux TRAVIS_REPO_SLUG=oh-my-fish/oh-my-fish TRAVIS_BRANCH=master
|
||||||
|
|
||||||
# Cache script folder
|
# Cache script folder
|
||||||
ADD script /src/script
|
ADD script /src/script
|
||||||
|
|
16
README.md
16
README.md
|
@ -1,12 +1,12 @@
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<a href="https://github.com/bpinto/oh-my-fish">
|
<a href="https://github.com/oh-my-fish/oh-my-fish">
|
||||||
<img width=20% src="https://cloud.githubusercontent.com/assets/958723/6883431/9beb62b0-d58b-11e4-902c-2f716859a7ad.png">
|
<img width=20% src="https://cloud.githubusercontent.com/assets/958723/6883431/9beb62b0-d58b-11e4-902c-2f716859a7ad.png">
|
||||||
</a>
|
</a>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<a name="omf"></a>
|
<a name="omf"></a>
|
||||||
|
|
||||||
[![Build Status](https://travis-ci.org/oh-my-fish/oh-my-fish.svg?branch=master)](https://travis-ci.org/bpinto/oh-my-fish) [![](https://img.shields.io/badge/Framework-Oh My Fish-blue.svg?style=flat)](https://github.com/oh-my-fish/oh-my-fish) ![](https://img.shields.io/cocoapods/l/AFNetworking.svg) [![Join the chat at https://gitter.im/bpinto/oh-my-fish](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/oh-my-fish/oh-my-fish?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
[![Build Status](https://travis-ci.org/oh-my-fish/oh-my-fish.svg?branch=master)](https://travis-ci.org/oh-my-fish/oh-my-fish) [![](https://img.shields.io/badge/Framework-Oh My Fish-blue.svg?style=flat)](https://github.com/oh-my-fish/oh-my-fish) ![](https://img.shields.io/cocoapods/l/AFNetworking.svg) [![Join the chat at https://gitter.im/oh-my-fish/oh-my-fish](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/oh-my-fish/oh-my-fish?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
||||||
|
|
||||||
|
|
||||||
# Oh My Fish!
|
# Oh My Fish!
|
||||||
|
@ -26,18 +26,18 @@
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
```fish
|
```fish
|
||||||
curl -L https://github.com/bpinto/oh-my-fish/raw/master/tools/install.fish | fish
|
curl -L https://github.com/oh-my-fish/oh-my-fish/raw/master/tools/install.fish | fish
|
||||||
```
|
```
|
||||||
|
|
||||||
**NOTE**: The installation script renames your existing `config.fish` to `config.orig`, and replaces it with [the default oh-my-fish config](https://github.com/bpinto/oh-my-fish/blob/master/templates/config.fish). If you have existing customizations to your fish config, you will need to manually include those customizations after the install.
|
**NOTE**: The installation script renames your existing `config.fish` to `config.orig`, and replaces it with [the default oh-my-fish config](https://github.com/oh-my-fish/oh-my-fish/blob/master/templates/config.fish). If you have existing customizations to your fish config, you will need to manually include those customizations after the install.
|
||||||
|
|
||||||
If you want to install it manually, [click here](https://github.com/bpinto/oh-my-fish/wiki/Manual-Installation).
|
If you want to install it manually, [click here](https://github.com/oh-my-fish/oh-my-fish/wiki/Manual-Installation).
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
Open your fish configuration file `~/.config/fish/config.fish` and specify the theme and the plugins you want to use. And then run `omf install` on your terminal to install them.
|
Open your fish configuration file `~/.config/fish/config.fish` and specify the theme and the plugins you want to use. And then run `omf 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.
|
Before setting down on a theme, you might want to have a go with all themes using our quick [theme switcher](https://github.com/oh-my-fish/oh-my-fish/blob/master/plugins/theme/README.md) by typing `theme --help` on your shell.
|
||||||
|
|
||||||
## Upgrading from previous version
|
## Upgrading from previous version
|
||||||
|
|
||||||
|
@ -53,7 +53,7 @@ If you just want to override any of the default behavior or add some environment
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
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.
|
Create an [issue](https://github.com/oh-my-fish/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.
|
||||||
|
|
||||||
## Uninstall
|
## Uninstall
|
||||||
|
|
||||||
|
@ -61,6 +61,6 @@ Create an [issue](https://github.com/bpinto/oh-my-fish/issues) linking to your r
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
[MIT](http://mit-license.org) © [Contributors](https://github.com/bpinto/oh-my-fish/graphs/contributors)
|
[MIT](http://mit-license.org) © [Contributors](https://github.com/oh-my-fish/oh-my-fish/graphs/contributors)
|
||||||
|
|
||||||
[Logo](https://cloud.githubusercontent.com/assets/958723/6847746/8d1b95b0-d3a7-11e4-866a-6bdc1eea0fe6.png) by [marcker](https://github.com/marcker):small_blue_diamond: [Attribution CC 4.0](http://creativecommons.org/licenses/by/4.0/)
|
[Logo](https://cloud.githubusercontent.com/assets/958723/6847746/8d1b95b0-d3a7-11e4-866a-6bdc1eea0fe6.png) by [marcker](https://github.com/marcker):small_blue_diamond: [Attribution CC 4.0](http://creativecommons.org/licenses/by/4.0/)
|
||||||
|
|
|
@ -4,10 +4,10 @@
|
||||||
The following guide describes how to use the `fish-spec` plugin bundled with Oh-My-Fish.
|
The following guide describes how to use the `fish-spec` plugin bundled with Oh-My-Fish.
|
||||||
|
|
||||||
## Install
|
## Install
|
||||||
Before you can use `fish-spec`, you need to install [Oh-My-Fish](https://github.com/bpinto/oh-my-fish).
|
Before you can use `fish-spec`, you need to install [Oh-My-Fish](https://github.com/oh-my-fish/oh-my-fish).
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
Import the library into your fish file via [import](https://github.com/bpinto/oh-my-fish/blob/master/functions/import.fish).
|
Import the library into your fish file via [import](https://github.com/oh-my-fish/oh-my-fish/blob/master/functions/import.fish).
|
||||||
|
|
||||||
Inside your project's directory create a new `spec` folder and add all your _spec_ files inside. _Spec_ files are regular fish files that shall look like `*.spec.fish` and contain your tests.
|
Inside your project's directory create a new `spec` folder and add all your _spec_ files inside. _Spec_ files are regular fish files that shall look like `*.spec.fish` and contain your tests.
|
||||||
|
|
||||||
|
@ -57,7 +57,7 @@ spec.run $argv
|
||||||
|
|
||||||
## API
|
## API
|
||||||
|
|
||||||
As of now, there is only one method you should be aware of, [expect](https://github.com/bpinto/oh-my-fish/blob/master/plugins/fish-spec/expect.fish):
|
As of now, there is only one method you should be aware of, [expect](https://github.com/oh-my-fish/oh-my-fish/blob/master/plugins/fish-spec/expect.fish):
|
||||||
|
|
||||||
> Assert a list of expected values match an actual value/s.
|
> Assert a list of expected values match an actual value/s.
|
||||||
|
|
||||||
|
|
|
@ -6,7 +6,7 @@
|
||||||
#
|
#
|
||||||
# Get the party started with:
|
# Get the party started with:
|
||||||
#
|
#
|
||||||
# curl -L https://github.com/bpinto/oh-my-fish/raw/master/tools/install.fish \
|
# curl -L https://github.com/oh-my-fish/oh-my-fish/raw/master/tools/install.fish \
|
||||||
# | fish
|
# | fish
|
||||||
#
|
#
|
||||||
# Oh-My-Fish currently supports
|
# Oh-My-Fish currently supports
|
||||||
|
@ -45,7 +45,7 @@ log white "Installing Oh My Fish..."
|
||||||
|
|
||||||
# Allow installers to specify the source repository.
|
# Allow installers to specify the source repository.
|
||||||
if not set -q TRAVIS_REPO_SLUG
|
if not set -q TRAVIS_REPO_SLUG
|
||||||
set TRAVIS_REPO_SLUG bpinto/oh-my-fish
|
set TRAVIS_REPO_SLUG oh-my-fish/oh-my-fish
|
||||||
set TRAVIS_BRANCH master
|
set TRAVIS_BRANCH master
|
||||||
end
|
end
|
||||||
|
|
||||||
|
@ -71,7 +71,7 @@ else
|
||||||
rm -f $fish_path.zip
|
rm -f $fish_path.zip
|
||||||
else
|
else
|
||||||
log red "Oh-My-Fish could not be downloaded."
|
log red "Oh-My-Fish could not be downloaded."
|
||||||
log white "Report an issue → github.com/bpinto/oh-my-fish/issues"
|
log white "Report an issue → github.com/oh-my-fish/oh-my-fish/issues"
|
||||||
exit 1
|
exit 1
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
Loading…
Reference in New Issue
Block a user