Skip to content
Newer
Older
100644 82 lines (43 sloc) 2.97 KB
14b219b @robbyrussell Updating README
robbyrussell authored Aug 28, 2009
1 A handful of functions, auto-complete helpers, and stuff that makes you shout...
2
3 bq. "OH MY ZSHELL!"
4
5da20b9 @robbyrussell Importing initial files after reorganizing stuff.
robbyrussell authored Aug 28, 2009
5 h2. Setup
6
3bc7301 @JNRowe Added a minimum zsh version note.
JNRowe authored Nov 12, 2009
7 @oh-my-zsh@ should work with any recent release of "zsh":http://www.zsh.org/, the minimum recommended version is 4.3.9.
8
43fd24e @robbyrussell Updating README with reference to auto-installer
robbyrussell authored Aug 30, 2009
9 h3. The automatic installer... (do you trust me?)
10
480d124 @robbyrussell Updating installation documentation to show a curl example as well fo…
robbyrussell authored Dec 26, 2011
11 You can install this via the command line with either `curl` or `wget`.
12
13 h4. via `curl`
14
15 @curl -L https://github.com/robbyrussell/oh-my-zsh/raw/master/tools/install.sh | sh@
16
17 h4. via `wget`
18
2497c57 @else fixed wget command in readme
else authored Mar 24, 2011
19 @wget --no-check-certificate https://github.com/robbyrussell/oh-my-zsh/raw/master/tools/install.sh -O - | sh@
43fd24e @robbyrussell Updating README with reference to auto-installer
robbyrussell authored Aug 31, 2009
20
21 h3. The manual way
22
23
4e2b71b @robbyrussell Updating README file
robbyrussell authored Aug 28, 2009
24 1. Clone the repository
25
908fead @robbyrussell Updating README to match new path for installation.
robbyrussell authored Aug 30, 2009
26 @git clone git://github.com/robbyrussell/oh-my-zsh.git ~/.oh-my-zsh@
4e2b71b @robbyrussell Updating README file
robbyrussell authored Aug 28, 2009
27
d1a9efc @robbyrussell Updating README to instruct people to copy the .zshrc template file v…
robbyrussell authored Sep 1, 2009
28 2. Create a new zsh config by copying the zsh template we've provided.
4e2b71b @robbyrussell Updating README file
robbyrussell authored Aug 28, 2009
29
1092aba @robbyrussell Adding a note about backing up your existing zshrc file
robbyrussell authored Aug 30, 2009
30 *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.
31
d1a9efc @robbyrussell Updating README to instruct people to copy the .zshrc template file v…
robbyrussell authored Sep 1, 2009
32 @cp ~/.oh-my-zsh/templates/zshrc.zsh-template ~/.zshrc@
95f32b4 @robbyrussell Updating README to show people how to change their default shell.
robbyrussell authored Aug 30, 2009
33
34 3. Set zsh as your default shell:
35
36 @chsh -s /bin/zsh@
37
b26ff05 updated the readme
toabi authored Jun 6, 2010
38 4. Start / restart zsh (open a new terminal is easy enough...)
4e2b71b @robbyrussell Updating README file
robbyrussell authored Aug 28, 2009
39
dcd664e @robbyrussell Note about PATH
robbyrussell authored Aug 28, 2009
40 h3. Problems?
41
b26ff05 updated the readme
toabi authored Jun 6, 2010
42 You _might_ need to modify your PATH in ~/.zshrc if you're not able to find some commands after switching to _Oh My Zsh_.
dcd664e @robbyrussell Note about PATH
robbyrussell authored Aug 28, 2009
43
d1e1869 @robbyrussell Adding some info to the Usage section of the README
robbyrussell authored Aug 28, 2009
44 h2. Usage
45
b26ff05 updated the readme
toabi authored Jun 6, 2010
46 * enable the plugins you want in your @~/.zshrc@ (take a look at @plugins/@ to see what's possible)
47 ** example: @plugins=(git osx ruby)@
5af0ba8 @robbyrussell Updating README with info about themes
robbyrussell authored Aug 31, 2009
48 * Theme support: Change the @ZSH_THEME@ environment variable in @~/.zshrc@.
ab1cbe9 @Nemo157 Should use https for all GitHub urls.
Nemo157 authored Feb 14, 2011
49 ** Take a look at the "current themes":https://wiki.github.com/robbyrussell/oh-my-zsh/themes that come bundled with _Oh My Zsh_.
b26ff05 updated the readme
toabi authored Jun 6, 2010
50 * much much more... take a look at @lib/@ what _Oh My Zsh_ offers...
4e2b71b @robbyrussell Updating README file
robbyrussell authored Aug 28, 2009
51
1304baf @imajes add in refcard note
imajes authored Sep 23, 2009
52 h2. Useful
8a8a7ba @imajes merge upstream
imajes authored Sep 23, 2009
53
1304baf @imajes add in refcard note
imajes authored Sep 23, 2009
54 the "refcard":http://www.bash2zsh.com/zsh_refcard/refcard.pdf is pretty tasty for tips.
55
1dc7353 @robbyrussell Updating README to mention custom/ directory
robbyrussell authored Sep 23, 2009
56 h3. Customization
57
58 If you want to override any of the default behavior, just add a new file (ending in @.zsh@) into the @custom/@ directory.
f8aae64 @theunraveler Adding ability to override plugins from the custom directory.
theunraveler authored May 26, 2011
59 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.
60 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/@.
61
1dc7353 @robbyrussell Updating README to mention custom/ directory
robbyrussell authored Sep 23, 2009
62
e1f5c0c @robbyrussell Adding an uninstaller tool
robbyrussell authored Aug 31, 2009
63 h3. Uninstalling
64
65 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).
66
14b219b @robbyrussell Updating README
robbyrussell authored Aug 28, 2009
67 h2. Help out!
5da20b9 @robbyrussell Importing initial files after reorganizing stuff.
robbyrussell authored Aug 28, 2009
68
c1ac59d @robbyrussell Info about contributing
robbyrussell authored Aug 28, 2009
69 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!
70
5af0ba8 @robbyrussell Updating README with info about themes
robbyrussell authored Aug 31, 2009
71 h3. Send us your theme!
72
2497c57 @else fixed wget command in readme
else authored Mar 24, 2011
73 I'm hoping to collect a bunch of themes for our command prompts. You can see existing ones in the @themes/@ directory.
849e283 @robbyrussell Updating the README... now links to contributors page
robbyrussell authored Apr 12, 2011
74
75 h2. Contributors
76
77 This project wouldn't exist without all of our awesome users and contributors.
78
79 * "View our growing list of contributors":https://github.com/robbyrussell/oh-my-zsh/contributors
80
f8aae64 @theunraveler Adding ability to override plugins from the custom directory.
theunraveler authored May 26, 2011
81 Thank you so much!
Something went wrong with that request. Please try again.