Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 70 lines (38 sloc) 2.74 kb
14b219b @robbyrussell Updating README
authored
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.
authored
5 h2. Setup
6
3bc7301 @JNRowe Added a minimum zsh version note.
JNRowe authored
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
authored
9 h3. The automatic installer... (do you trust me?)
10
2497c57 @else fixed wget command in readme
else authored
11 @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
authored
12
13 h3. The manual way
14
15
4e2b71b @robbyrussell Updating README file
authored
16 1. Clone the repository
17
908fead @robbyrussell Updating README to match new path for installation.
authored
18 @git clone git://github.com/robbyrussell/oh-my-zsh.git ~/.oh-my-zsh@
4e2b71b @robbyrussell Updating README file
authored
19
d1a9efc @robbyrussell Updating README to instruct people to copy the .zshrc template file v…
authored
20 2. Create a new zsh config by copying the zsh template we've provided.
4e2b71b @robbyrussell Updating README file
authored
21
1092aba @robbyrussell Adding a note about backing up your existing zshrc file
authored
22 *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.
23
d1a9efc @robbyrussell Updating README to instruct people to copy the .zshrc template file v…
authored
24 @cp ~/.oh-my-zsh/templates/zshrc.zsh-template ~/.zshrc@
95f32b4 @robbyrussell Updating README to show people how to change their default shell.
authored
25
26 3. Set zsh as your default shell:
27
28 @chsh -s /bin/zsh@
29
b26ff05 updated the readme
toabi authored
30 4. Start / restart zsh (open a new terminal is easy enough...)
4e2b71b @robbyrussell Updating README file
authored
31
dcd664e @robbyrussell Note about PATH
authored
32 h3. Problems?
33
b26ff05 updated the readme
toabi authored
34 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
authored
35
d1e1869 @robbyrussell Adding some info to the Usage section of the README
authored
36 h2. Usage
37
b26ff05 updated the readme
toabi authored
38 * enable the plugins you want in your @~/.zshrc@ (take a look at @plugins/@ to see what's possible)
39 ** example: @plugins=(git osx ruby)@
5af0ba8 @robbyrussell Updating README with info about themes
authored
40 * Theme support: Change the @ZSH_THEME@ environment variable in @~/.zshrc@.
ab1cbe9 @Nemo157 Should use https for all GitHub urls.
Nemo157 authored
41 ** 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
42 * much much more... take a look at @lib/@ what _Oh My Zsh_ offers...
4e2b71b @robbyrussell Updating README file
authored
43
1304baf @imajes add in refcard note
imajes authored
44 h2. Useful
8a8a7ba @imajes merge upstream
imajes authored
45
1304baf @imajes add in refcard note
imajes authored
46 the "refcard":http://www.bash2zsh.com/zsh_refcard/refcard.pdf is pretty tasty for tips.
47
1dc7353 @robbyrussell Updating README to mention custom/ directory
authored
48 h3. Customization
49
50 If you want to override any of the default behavior, just add a new file (ending in @.zsh@) into the @custom/@ directory.
b26ff05 updated the readme
toabi authored
51 If you have many functions which go good together you can put them as a *.plugin.zsh file in the @plugin/@ directory and then enable this plugin.
1dc7353 @robbyrussell Updating README to mention custom/ directory
authored
52
e1f5c0c @robbyrussell Adding an uninstaller tool
authored
53 h3. Uninstalling
54
55 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).
56
14b219b @robbyrussell Updating README
authored
57 h2. Thanks
58
81acebe @technoweenie gave credit to Nick for the rake autocompletion code.
technoweenie authored
59 * Rick Olson (technoweenie) might remember some of the configuration, which I took from a pastie a few years ago.
60 * Marcel (noradio) provided Rick the original zsh configuration.
61 * Nicholas (ulysses) for the "rake autocompletion code":http://weblog.rubyonrails.org/2006/3/9/fast-rake-task-completion-for-zsh.
5da20b9 @robbyrussell Importing initial files after reorganizing stuff.
authored
62
14b219b @robbyrussell Updating README
authored
63 h2. Help out!
5da20b9 @robbyrussell Importing initial files after reorganizing stuff.
authored
64
c1ac59d @robbyrussell Info about contributing
authored
65 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!
66
5af0ba8 @robbyrussell Updating README with info about themes
authored
67 h3. Send us your theme!
68
2497c57 @else fixed wget command in readme
else authored
69 I'm hoping to collect a bunch of themes for our command prompts. You can see existing ones in the @themes/@ directory.
Something went wrong with that request. Please try again.