mirror of
https://github.com/ohmyzsh/ohmyzsh.git
synced 2024-11-22 05:40:08 +00:00
Update README.textile
This commit is contained in:
Adam Poskitt
parent
1b7a3ea99a
commit
397a9f7b7b
1 changed files with 42 additions and 42 deletions
|
|
@ -1,111 +1,111 @@
|
||||||
!https://s3.amazonaws.com/ohmyzsh/oh-my-zsh-logo.png!
|
!https://s3.amazonaws.com/ohmyzsh/oh-my-zsh-logo.png!
|
||||||
|
|
||||||
oh-my-zsh is an open source, community-driven framework for managing your ZSH configuration. It comes bundled with a ton of helpful functions, helpers, plugins, themes, and few things that make you shout...
|
@oh-my-zsh@ is an open source, community-driven framework for managing your "Zsh":http://www.zsh.org/ configuration.
|
||||||
|
|
||||||
|
It comes bundled with a ton of helpful functions, helpers, plugins, themes, and a few things that make you shout…
|
||||||
|
|
||||||
bq. "OH MY ZSHELL!"
|
bq. "OH MY ZSHELL!"
|
||||||
|
|
||||||
h2. Setup
|
h2. Setup
|
||||||
|
|
||||||
@oh-my-zsh@ should work with any recent release of "zsh":http://www.zsh.org/, the minimum recommended version is 4.3.9.
|
@oh-my-zsh@ should work with any recent release of "Zsh":http://www.zsh.org/. The minimum recommended version is *4.3.9*.
|
||||||
If not already, install zsh using the command line first.
|
|
||||||
|
|
||||||
h3. The automatic installer... (do you trust me?)
|
If not already installed, you can install "Zsh":http://www.zsh.org/ using the command-line.
|
||||||
|
|
||||||
You can install this via the command line with either @curl@ or @wget@.
|
h3. The automatic installer… do you trust me?
|
||||||
|
|
||||||
h4. via @curl@
|
You can install this via the command-line with either @curl@ or @wget@.
|
||||||
|
|
||||||
|
h4. via @curl@:
|
||||||
|
|
||||||
@curl -L http://install.ohmyz.sh | sh@
|
@curl -L http://install.ohmyz.sh | sh@
|
||||||
|
|
||||||
h4. via @wget@
|
h4. via @wget@:
|
||||||
|
|
||||||
@wget --no-check-certificate http://install.ohmyz.sh -O - | sh@
|
@wget --no-check-certificate http://install.ohmyz.sh -O - | sh@
|
||||||
|
|
||||||
h4. Optional: change the install directory
|
h4. *Optionally*, change the install directory:
|
||||||
|
|
||||||
The default location is @~/.oh-my-zsh@ (hidden in your home directory).
|
The default location is @~/.oh-my-zsh@ (hidden in your home directory).
|
||||||
|
|
||||||
You can change the install directory with the ZSH environment variable, either
|
You can change the install directory with the @ZSH@ environment variable, either by running @export ZSH=/your/path@ before installing, or by setting it before the end of the install pipeline like this:
|
||||||
by running @export ZSH=/your/path@ before installing, or setting it before the
|
|
||||||
end of the install pipeline like this:
|
|
||||||
|
|
||||||
@curl -L https://raw.github.com/robbyrussell/oh-my-zsh/master/tools/install.sh | ZSH=~/.dotfiles/zsh sh@
|
@curl -L https://raw.github.com/robbyrussell/oh-my-zsh/master/tools/install.sh | ZSH=~/.dotfiles/zsh sh@
|
||||||
|
|
||||||
|
|
||||||
h3. The manual way
|
h3. The manual way
|
||||||
|
|
||||||
1. Clone the repository
|
1. Clone the repository:
|
||||||
|
|
||||||
@git clone git://github.com/robbyrussell/oh-my-zsh.git ~/.oh-my-zsh@
|
@git clone git://github.com/robbyrussell/oh-my-zsh.git ~/.oh-my-zsh@
|
||||||
|
|
||||||
2. *OPTIONAL* Backup your existing @~/.zshrc@ file
|
2. *Optionally*, backup your existing @~/.zshrc@ file:
|
||||||
|
|
||||||
@cp ~/.zshrc ~/.zshrc.orig@
|
@cp ~/.zshrc ~/.zshrc.orig@
|
||||||
|
|
||||||
3. Create a new zsh config by copying the zsh template we've provided.
|
3. Create a new "Zsh":http://www.zsh.org/ config file by copying the "Zsh":http://www.zsh.org/ template we've provided:
|
||||||
|
|
||||||
@cp ~/.oh-my-zsh/templates/zshrc.zsh-template ~/.zshrc@
|
@cp ~/.oh-my-zsh/templates/zshrc.zsh-template ~/.zshrc@
|
||||||
|
|
||||||
4. Set zsh as your default shell:
|
4. Set "Zsh":http://www.zsh.org/ as your default shell:
|
||||||
|
|
||||||
@chsh -s /bin/zsh@
|
@chsh -s /bin/zsh@
|
||||||
|
|
||||||
5. Start / restart zsh (open a new terminal is easy enough...)
|
5. Start or restart "Zsh":http://www.zsh.org/ by opening a new command-line window.
|
||||||
|
|
||||||
h3. Problems?
|
h3. Problems?
|
||||||
|
|
||||||
You _might_ need to modify your @PATH@ in @~/.zshrc@ if you're not able to find some commands after switching to _Oh My Zsh_.
|
You _might_ need to modify your @PATH@ in @~/.zshrc@ if you're not able to find some commands after switching to @oh-my-zsh@.
|
||||||
|
|
||||||
If you installed manually or changed the install location, check ZSH in @~/.zshrc@
|
If you installed manually or changed the install location, check the @ZSH@ environment variable in @~/.zshrc@.
|
||||||
|
|
||||||
h2. Usage
|
h2. Usage
|
||||||
|
|
||||||
* enable the plugins you want in your @~/.zshrc@ (take a look at the @plugins/@ directory and the "wiki":https://github.com/robbyrussell/oh-my-zsh/wiki/Plugins to see what's possible)
|
* enable the plugins you want in your @~/.zshrc@ (take a look at the @plugins/@ directory and the "wiki":https://github.com/robbyrussell/oh-my-zsh/wiki/Plugins to see what's available)
|
||||||
** example: @plugins=(git osx ruby)@
|
** example: @plugins=(git osx ruby)@
|
||||||
* Theme support: Change the @ZSH_THEME@ environment variable in @~/.zshrc@.
|
* theme support: change the @ZSH_THEME@ environment variable in @~/.zshrc@
|
||||||
** Take a look at the "current themes":https://wiki.github.com/robbyrussell/oh-my-zsh/themes that come bundled with _Oh My Zsh_.
|
** take a look at the @themes/@ directory and the "wiki":https://wiki.github.com/robbyrussell/oh-my-zsh/themes to see what comes bundled with @oh-my-zsh@
|
||||||
* much much more... take a look at @lib/@ what _Oh My Zsh_ offers...
|
* & much, much more… take a look at the @lib/@ directory to see what @oh-my-zsh@ has to offer…
|
||||||
|
|
||||||
h2. Useful
|
h2. Useful
|
||||||
|
|
||||||
the "refcard":http://www.bash2zsh.com/zsh_refcard/refcard.pdf is pretty tasty for tips.
|
The "refcard":http://www.bash2zsh.com/zsh_refcard/refcard.pdf is pretty useful for tips.
|
||||||
|
|
||||||
h3. Customization
|
h3. Customization
|
||||||
|
|
||||||
If you want to override any of the default behavior, just add a new file (ending in @.zsh@) into the @custom/@ directory.
|
If you want to override any of the default behaviors, just add a new file (ending in @.zsh@) in the @custom/@ directory.
|
||||||
If you have many functions which go well together you can put them as a @*.plugin.zsh@ 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-zsh, create a plugin of the same name in the @custom/plugins/@ directory and it will be loaded instead of the one in @plugins/@.
|
If you have many functions that go well together, you can put them as a @*.plugin.zsh@ file in the @custom/plugins/@ directory and then enable this plugin (see '"Usage":https://github.com/robbyrussell/oh-my-zsh#usage' above).
|
||||||
|
|
||||||
|
If you would like to override the functionality of a plugin distributed with @oh-my-zsh@, create a plugin of the same name in the @custom/plugins/@ directory and it will be loaded instead of the one in @plugins/@.
|
||||||
|
|
||||||
h3. Updates
|
h3. Updates
|
||||||
|
|
||||||
By default you will be prompted to check for updates. If you would like oh-my-zsh to automatically update itself without prompting you, set the following in your @~/.zshrc@
|
By default you will be prompted to check for upgrades. If you would like @oh-my-zsh@ to automatically upgrade itself without prompting you, set the following in your @~/.zshrc@:
|
||||||
|
|
||||||
@DISABLE_UPDATE_PROMPT=true@
|
@DISABLE_UPDATE_PROMPT=true@
|
||||||
|
|
||||||
To disable updates entirely, put this in your @~/.zshrc@
|
To disable upgrades entirely, set the following in your @~/.zshrc@:
|
||||||
|
|
||||||
@DISABLE_AUTO_UPDATE=true@
|
@DISABLE_AUTO_UPDATE=true@
|
||||||
|
|
||||||
To upgrade directly from the command line, just run @upgrade_oh_my_zsh@
|
To upgrade directly from the command-line, just run @upgrade_oh_my_zsh@.
|
||||||
|
|
||||||
h3. Uninstalling
|
h3. Uninstalling
|
||||||
|
|
||||||
If you want to uninstall it, just run @uninstall_oh_my_zsh@ from the command line and it'll remove itself and revert you to bash (or your previous zsh config).
|
If you want to uninstall @oh-my-zsh@, just run @uninstall_oh_my_zsh@ from the command-line and it'll remove itself and revert you to @bash@ (or your previous "Zsh":http://www.zsh.org/ configuration).
|
||||||
|
|
||||||
h2. Help out!
|
h2. Help out!
|
||||||
|
|
||||||
I'm far from being a zsh-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!
|
I'm far from being a "Zsh":http://www.zsh.org/ 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. (Don't) Send us your theme! (for now)
|
h3. (Don't) send us your theme (for now)!
|
||||||
|
|
||||||
-I'm hoping to collect a bunch of themes for our command prompts. You can see existing ones in the @themes/@ directory.-
|
-I'm hoping to collect a bunch of themes – you can see existing ones in the @themes/@ directory.-
|
||||||
|
|
||||||
We have enough themes for the time being. Please fork the project and add on in there, you can let people know how to grab it from there.
|
We have enough themes for the time being. Please fork the project and add on in there – you can let people know how to grab it from there.
|
||||||
|
|
||||||
h2. Contributors
|
h2. Contributors
|
||||||
|
|
||||||
This project wouldn't exist without all of our awesome users and contributors.
|
This project wouldn't exist without all of our awesome users and contributors: "view our growing list of contributors":https://github.com/robbyrussell/oh-my-zsh/contributors
|
||||||
|
|
||||||
* "View our growing list of contributors":https://github.com/robbyrussell/oh-my-zsh/contributors
|
|
||||||
|
|
||||||
Thank you so much!
|
Thank you so much!
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue