summaryrefslogtreecommitdiff
path: root/README.textile
diff options
context:
space:
mode:
Diffstat (limited to 'README.textile')
-rw-r--r--README.textile57
1 files changed, 47 insertions, 10 deletions
diff --git a/README.textile b/README.textile
index 2dbfbe5a6..c808fb5d7 100644
--- a/README.textile
+++ b/README.textile
@@ -1,4 +1,6 @@
-A handful of functions, auto-complete helpers, and stuff that makes you shout...
+!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...
bq. "OH MY ZSHELL!"
@@ -8,31 +10,53 @@ h2. Setup
h3. The automatic installer... (do you trust me?)
-@wget --no-check-certificate https://github.com/robbyrussell/oh-my-zsh/raw/master/tools/install.sh -O - | sh@
+You can install this via the command line with either `curl` or `wget`.
-h3. The manual way
+h4. via `curl`
+
+@curl -L http://install.ohmyz.sh | sh@
+
+h4. via `wget`
+
+@wget --no-check-certificate http://install.ohmyz.sh -O - | sh@
+h4. Optional: change the install 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
+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@
+
+
+h3. The manual way
1. Clone the repository
@git clone git://github.com/robbyrussell/oh-my-zsh.git ~/.oh-my-zsh@
-2. Create a new zsh config by copying the zsh template we've provided.
+2. *OPTIONAL* Backup your existing ~/.zshrc file
+
+ @cp ~/.zshrc ~/.zshrc.orig@
- *NOTE*: If you already have a ~/.zshrc file, you should back it up. @cp ~/.zshrc ~/.zshrc.orig@ in case you want to go back to your original settings.
+3. Create a new zsh config by copying the zsh template we've provided.
@cp ~/.oh-my-zsh/templates/zshrc.zsh-template ~/.zshrc@
-3. Set zsh as your default shell:
+4. Set zsh as your default shell:
@chsh -s /bin/zsh@
-4. Start / restart zsh (open a new terminal is easy enough...)
+5. Start / restart zsh (open a new terminal is easy enough...)
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_.
+If you installed manually or changed the install location, check ZSH in ~/.zshrc
+
h2. Usage
* enable the plugins you want in your @~/.zshrc@ (take a look at @plugins/@ to see what's possible)
@@ -48,9 +72,20 @@ the "refcard":http://www.bash2zsh.com/zsh_refcard/refcard.pdf is pretty tasty fo
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 have many functions which go good together you can put them as a *.plugin.zsh file in the @custom/plugins/@ directory and then enable this plugin.
+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/@.
+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
+
+@DISABLE_UPDATE_PROMPT=true@
+
+To disable updates entirely, put this in your ~/.zshrc
+
+@DISABLE_AUTO_UPDATE=true@
+
+To upgrade directly from the command line, just run @upgrade_oh_my_zsh@
h3. Uninstalling
@@ -60,9 +95,11 @@ 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!
-h3. Send us your theme!
+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 for our command prompts. 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.
h2. Contributors