Skip to content

Commit

Permalink
Merge remote-tracking branch 'upstream/master'
Browse files Browse the repository at this point in the history
* upstream/master: (113 commits)
  Fix SSH-Agent casing in README
  [Fix sorin-ionescu#300] Disable SSH-Agent protocol emulation by default
  Update external completions
  [Fix sorin-ionescu#129, Fix sorin-ionescu#211] Add fasd
  [sorin-ionescu#129, sorin-ionescu#211] Remove z
  Load dependencies after requirements check
  Add a missing space to peepcode
  Simplify mkdcd completion
  Add completion for Git submodule moving and removing
  Silence git-branch-current in aliases
  Make sure that the current directory is a Git repository
  Return inside of the if statement
  Simplify git-config calls
  Fix a #compdef bug introduced in 7dd7859
  Add missing backslashes
  Define variable expl as local
  Load dependencies in Git init
  [Fix sorin-ionescu#303] Remove extra '/' in sorin theme
  [Fix sorin-ionescu#301] Unset $MATCH after use
  Ensure $key_info is populated before use
  ...
  • Loading branch information
pbrisbin committed Oct 1, 2012
2 parents d322ba9 + f8da045 commit ffca226
Show file tree
Hide file tree
Showing 113 changed files with 1,871 additions and 849 deletions.
4 changes: 2 additions & 2 deletions .gitmodules
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@
[submodule "modules/syntax-highlighting/external"]
path = modules/syntax-highlighting/external
url = https://github.com/zsh-users/zsh-syntax-highlighting.git
[submodule "modules/completion/functions"]
path = modules/completion/functions
[submodule "modules/completion/external"]
path = modules/completion/external
url = https://github.com/zsh-users/zsh-completions.git
42 changes: 42 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
Contributing
------------

This project would not exist without all of its users and [contributors][1].

If you have ideas on how to make the configuration easier to maintain or
improve its performance, do not hesitate to fork and send pull requests.

### Issue Reporting

- Check that the issue has not already been reported.
- Check that the issue has not already been fixed in the latest code.
- Open an issue with a clear title and description in grammatically correct,
complete sentences.

### Pull Request

- Read [how to properly contribute to open source projects on GitHub][2].
- Use a topic branch to easily amend a pull request later, if necessary.
- Write [good commit messages][3].
- Squash commits on the topic branch before opening a pull request.
- Use the same coding style and spacing.
- Open a [pull request][4] that relates to but one subject with a clear
title and description in grammatically correct, complete sentences.

#### Modules

- A *README.md* must be present.
- Large functions must be placed in a *functions* directory.
- Functions that take arguments must have completion.

#### Themes

- A screenshots section must be present in the file header.
- The pull request description must have [embedded screenshots][5].

[1]: https://github.com/sorin-ionescu/prezto/contributors
[2]: http://gun.io/blog/how-to-github-fork-branch-and-pull-request
[3]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
[4]: https://help.github.com/articles/using-pull-requests
[5]: http://daringfireball.net/projects/markdown/syntax#img

96 changes: 27 additions & 69 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,37 @@
Oh My Zsh
=========
Prezto — Instantly Awesome Zsh
==============================

OMZ is a configuration framework for [Zsh][1] that enriches the command line
Prezto is the configuration framework for [Zsh][1]; it enriches the command line
interface environment with sane defaults, aliases, functions, auto completion,
and prompt themes.

Installation
------------

Oh My Zsh will work with any recent release of Zsh, but the minimum recommended
Prezto will work with any recent release of Zsh, but the minimum recommended
version is 4.3.10.

1. Clone the repository:
1. Launch Zsh:

git clone --recursive https://github.com/sorin-ionescu/oh-my-zsh.git ~/.oh-my-zsh
zsh

2. Create a new Zsh configuration by copying the Zsh configuration file
runcoms provided:
2. Clone the repository:

for rcfile in ~/.oh-my-zsh/runcoms/z{shenv,shrc,login,logout}; do
cp -f $rcfile ~/.$rcfile:t
git clone --recursive https://github.com/sorin-ionescu/prezto.git "${ZDOTDIR:-$HOME}/.zprezto"

3. Create a new Zsh configuration by copying the Zsh configuration files
provided:

setopt EXTENDED_GLOB
for rcfile in "${ZDOTDIR:-$HOME}"/.zprezto/runcoms/^README.md(.N); do
ln -s "$rcfile" "${ZDOTDIR:-$HOME}/.${rcfile:t}"
done

3. Set Zsh as your default shell:
4. Set Zsh as your default shell:

chsh -s /bin/zsh

4. Open a new Zsh terminal window or tab.
5. Open a new Zsh terminal window or tab.

### Mac OS X

Expand All @@ -49,28 +54,28 @@ directories end up at the tail of the array.

### Troubleshooting

If you are not able to find certain commands after switching to *Oh My Zsh*,
If you are not able to find certain commands after switching to *Prezto*,
modify the `PATH` variable in *~/.zshenv* then open a new Zsh terminal
window or tab.

Usage
-----

Oh My Zsh has many features disabled by default. Read the source code and
Prezto has many features disabled by default. Read the source code and
accompanying README files to learn of what is available.

### Modules

1. Browse */modules* to see what is available.
2. Load the modules you need in *~/.zshrc* then open a new Zsh terminal window
or tab.
2. Load the modules you need in *~/.zpreztorc* then open a new Zsh terminal
window or tab.

### Themes

1. For a list of themes, type `prompt -l`.
2. To preview a theme, type `prompt -p name`.
3. Load the theme you like in *~/.zshrc* then open a new Zsh terminal window
or tab.
3. Load the theme you like in *~/.zpreztorc* then open a new Zsh terminal
window or tab.

![sorin theme][2]

Expand All @@ -81,52 +86,10 @@ The project is managed via [Git][3]. It is highly recommend that you commit
your changes and push them to [GitHub][4] to not lose them. If you do not know
how to use Git, follow this [tutorial][5] and bookmark this [reference][6].

### Completions

Submit program completions to the [zsh-completions][7] project. The Oh My Zsh
completions directory will be synchronized against it.

Resources
---------

The [Zsh Reference Card][8] is indispensable.

Contribute
----------

This project would not exist without all of its users and [contributors][9].

If you have ideas on how to make the configuration easier to maintain or
improve its performance, do not hesitate to fork and send pull requests.

### Issue Reporting

- Check that the issue has not already been reported.
- Check that the issue has not already been fixed in the latest code.
- Open an issue with a clear title and description in grammatically correct,
complete sentences.

### Pull Request

- Read [how to properly contribute to open source projects on GitHub][10].
- Use a topic branch to easily amend a pull request later, if necessary.
- Write [good commit messages][11].
- Squash commits on the topic branch before opening a pull request.
- Use the same coding style and spacing.
- Open a [pull request][12] that relates to but one subject with a clear
title and description in gramatically correct, complete sentences.

#### Modules

- A *README.md* must be present.
- Large functions must be placed in a *functions* directory.
- Functions that take arguments must have completion.

#### Themes

- A screenshots section must be present in the file header.
- The pull request description must have must have [embedded
screenshots][13].
The [Zsh Reference Card][7] and the [zsh-lovers][8] man page are indispensable.

License
-------
Expand Down Expand Up @@ -154,16 +117,11 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

[1]: http://www.zsh.org
[2]: http://i.imgur.com/aipDQ.png "sorin theme"
[2]: http://i.imgur.com/nBEEZ.png "sorin theme"
[3]: http://git-scm.com
[4]: https://github.com
[5]: http://gitimmersion.com
[6]: http://gitref.org
[7]: https://github.com/zsh-users/zsh-completions
[8]: http://www.bash2zsh.com/zsh_refcard/refcard.pdf
[9]: https://github.com/sorin-ionescu/oh-my-zsh/contributors
[10]: http://gun.io/blog/how-to-github-fork-branch-and-pull-request
[11]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
[12]: https://help.github.com/articles/using-pull-requests
[13]: http://daringfireball.net/projects/markdown/syntax#img
[7]: http://www.bash2zsh.com/zsh_refcard/refcard.pdf
[8]: http://grml.org/zsh/zsh-lovers.html

93 changes: 0 additions & 93 deletions helper.zsh

This file was deleted.

Loading

0 comments on commit ffca226

Please sign in to comment.