README.textile 1.59 KB
Newer Older
Robby Russell's avatar
Robby Russell committed
1
2
3
4
A handful of functions, auto-complete helpers, and stuff that makes you shout...

bq. "OH MY ZSHELL!"

5
6
h2. Setup

7
8
9
10
11
12
13
h3. The automatic installer... (do you trust me?)

@wget http://github.com/robbyrussell/oh-my-zsh/raw/master/tools/install.sh -O - | sh@

h3. The manual way


Robby Russell's avatar
Robby Russell committed
14
15
1. Clone the repository

16
  @git clone git://github.com/robbyrussell/oh-my-zsh.git@
Robby Russell's avatar
Robby Russell committed
17

18
2. Symlink the zsh config with:
Robby Russell's avatar
Robby Russell committed
19

20
21
  *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.

22
23
24
25
26
27
28
  @ln -s ~/oh-my-zsh/zshrc ~/.zshrc@

3. Set zsh as your default shell:

  @chsh -s /bin/zsh@

4. Start / restart zsh (open a new terminal is easy enough..)
Robby Russell's avatar
Robby Russell committed
29

Robby Russell's avatar
Robby Russell committed
30
31
h3. Problems?

32
You _might_ need to modify your PATH in ~/.zshrc if you're not able to find some commands after switching to oh-my-zsh.
Robby Russell's avatar
Robby Russell committed
33

34
35
36
37
38
39
40
41
h2. Usage

TODO: Update this..

* Rake autocomplete: @rake (tab)@. Will generate a cache of all your rake tasks and then let you auto-complete and/or select the task to run.
* ssh autocomplete: @ssh (tab)@ or @scp (tab)@
* Git branch, it'll tell you which branch you're in when you're in a git repository directory.
* much much more..
Robby Russell's avatar
Robby Russell committed
42

Robby Russell's avatar
Robby Russell committed
43
44
45
46
h2. Thanks

* Rick Olsen (technoweenie) might remember some of the configuration, which I took from a pastie a few years ago.
* Whoever created the rake autocomplete stuff, which was posted all over the internet a few years ago.
47

Robby Russell's avatar
Robby Russell committed
48
h2. Help out!
49

Robby Russell's avatar
Robby Russell committed
50
51
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!

52