From 5215330886330216f84bed6241fa5069fd74635f Mon Sep 17 00:00:00 2001 From: Simon Gomizelj Date: Tue, 29 Nov 2011 12:11:58 -0500 Subject: [PATCH] New README in markdown. --- README.md | 71 ++++++++++++++++++++++++++++++++++++++++++++++++++ README.textile | 68 ----------------------------------------------- 2 files changed, 71 insertions(+), 68 deletions(-) create mode 100644 README.md delete mode 100644 README.textile diff --git a/README.md b/README.md new file mode 100644 index 000000000..86ee48fa4 --- /dev/null +++ b/README.md @@ -0,0 +1,71 @@ +"OH MY ZSHELL!" +=============== + +**NOTE**: This documentation isn't finished and this project is +currently under rapid development. Be cautious, information here may +not be up to date. + +**NOTE**: This fork is specifically for Archlinux and has been patched +for a system-wide install; Don't attempt to install to ~/.oh-my-zsh! +This project had radically diverged away from its source. While +plugins should remain compatible, there is much which has changed. + +Setup +----- + +`oh-my-zsh` should work with any recent release of [zsh][], the +minimum recommended version is 4.3.9. + +A package can be found in Archlinux's [AUR][oh-my-zsh-git]. We +recommend using [cower] to install it: + +``` +cower -dd oh-my-zsh-git +``` + + [zsh]: http://www.zsh.org/ + [oh-my-zsh-git]: https://aur.archlinux.org/packages.php?ID=54375 + [cower]: https://github.com/falconindy/cower + +The user must have zsh set as their shell. + +``` +# chsh -s /bin/zsh +``` + +The following needs to be added to the start of the user's `~/.zshrc` +file to activate oh-my-zshell goodness. + +``` +ZSH_THEME="arch-blue" +plugins=(archlinux sprunge git) +load_oh_my_zshell +``` + +A skeleton template can be found in +`/usr/share/oh-my-zsh/templates/user.zsh-template` + +Customization +============= + +- To enable more the plugins, customize the plugins array in your + `~/.zshrc` +- To change themes, change the @ZSH_THEME@ environment variable in + `~/.zshrc`. + +If you want to override any of the default behaviour, just add a new +file (ending in `.zsh`) into the `~/.omz/` directory. If you have many +functions which go good together you can put them as a *.plugin.zsh +file in the `~/.omz/plugins/` directory. + +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 +`~/.omz/plugins/` directory and it will be loaded instead of the one +provided one. + +Resources +--------- + +The [refcard][] is pretty tasty for tips. + + [refcard]: http://www.bash2zsh.com/zsh_refcard/refcard.pdf diff --git a/README.textile b/README.textile deleted file mode 100644 index 290dc990b..000000000 --- a/README.textile +++ /dev/null @@ -1,68 +0,0 @@ -**NOTE: This fork is specifically for Archlinux and has been patched for a system-wide install; Don't attempt to install to ~/.oh-my-zsh!! There will be a user specifc wrapper later on, but for now. system wide or use robby's official master ( not optimized for arch nor as patched; He is too lazy to merge some pull requests. )** -**This documentation/wiki isn't finished nor official!** - -A handful of functions, auto-complete helpers, and stuff that makes you shout... - -bq. "OH MY ZSHELL!" - -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. - -h3. Installing using cower - -@cower -dd oh-my-zsh-git@ - -h4. Enableing for a user. - -The user must first have zsh set as their shell. -@[[ $SHELL != '/bin/zsh' ]] && su -c'chsh -s $(which zsh) '@ - -For each user who wishes to use oh-my-zsh they must append/copy the user.zsh-template to their .zshrc. -@>$HOME/.zshrc@ -If the above command doesn't run please try.. -@cat /usr/share/oh-my-zsh/templates/user.zsh-template>>$HOME/.zshrc@ -If that doesn't work and you don't have anything in your .zshrc file. simply copy the file accross. - -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_. - -h2. Usage - -* enable the plugins you want in your @~/.zshrc@ (take a look at @plugins/@ to see what's possible) -** example: @plugins=(git osx ruby)@ -* 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_. -* much much more... take a look at @lib/@ what _Oh My Zsh_ offers... - -h2. Useful - -the "refcard":http://www.bash2zsh.com/zsh_refcard/refcard.pdf is pretty tasty for tips. - -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 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. 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). - -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! - -I'm hoping to collect a bunch of themes for our command prompts. You can see existing ones in the @themes/@ directory. - -h2. 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 - -Thank you so much!