mirror of
https://github.com/ohmyzsh/ohmyzsh.git
synced 2024-11-11 00:10:08 +00:00
Moving README to markdown... and taking first steps at reorganizing it. Also updated the LICENSE to reflect 2015.
This commit is contained in:
Robby Russell
parent
77140a2ea7
commit
8f1741d56c
3 changed files with 176 additions and 112 deletions
|
|
@ -1,6 +1,6 @@
|
|||
The MIT License
|
||||
|
||||
Copyright (c) 2009-2014 Robby Russell and contributors (see https://github.com/robbyrussell/oh-my-zsh/contributors)
|
||||
Copyright (c) 2009-2015 Robby Russell and contributors (see https://github.com/robbyrussell/oh-my-zsh/contributors)
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
|
|
|
|||
175
README.markdown
Normal file
175
README.markdown
Normal file
|
|
@ -0,0 +1,175 @@
|
|||
|
||||
|
||||
|
||||
Oh My Zsh is an open source, community-driven framework for managing your [zsh](http://www.zsh.org/) configuration. That sounds boring. Let's try this again.
|
||||
|
||||
Oh My Zsh is a way of life. Once installed, your terminal prompt will become the talk of the town. Everytime you begin interacting with your command prompt, you'll begin to take advantage of the hundreds of bundled plugins and pretty themes. Strangers will come up to you in cafés and ask you, _"that is amazing. are you some sort of genius?"_ Finally, you'll begin to get the sort of attention that you always felt that you deserved. ...or maybe you'll just use the time that you saved to start flossing more often.
|
||||
|
||||
To learn more, visit http://ohmyz.sh and/or follow [ohmyzsh](https://twitter.com/ohmyzsh) on twitter.
|
||||
|
||||
## Getting Started
|
||||
|
||||
|
||||
### Pre-requisites
|
||||
|
||||
__Disclaimer:__ _Oh My Zsh works best on Mac OS X and Linux._
|
||||
|
||||
* Unix-based operating system (Mac OS X or Linux)
|
||||
* [Zsh](http://www.zsh.org) should be installed (v4.3.9 or more recent)
|
||||
* This is commonly pre-installed. (`zsh --version` to confirm)
|
||||
* `curl` or `wget` should be installed
|
||||
|
||||
### Basic Installation
|
||||
|
||||
Oh My Zsh is installed by running one of the following commands in your terminal. You can install this via the command-line with either @curl@ or @wget@.
|
||||
|
||||
#### via curl
|
||||
|
||||
`curl -L https://raw.github.com/robbyrussell/oh-my-zsh/master/tools/install.sh | sh`
|
||||
|
||||
#### via wget
|
||||
|
||||
`wget --no-check-certificate https://raw.github.com/robbyrussell/oh-my-zsh/master/tools/install.sh -O - | sh`
|
||||
|
||||
## Using Oh My Zsh
|
||||
|
||||
### Plugins
|
||||
|
||||
Oh My Zsh comes with a shit load of plugins to take advantage of. You can take a look in the [plugins](https://github.com/robbyrussell/oh-my-zsh/tree/master/plugins) directory and/or the [wiki](https://github.com/robbyrussell/oh-my-zsh/wiki/Plugins) to see what's currently available.
|
||||
|
||||
#### Enabling Plugins
|
||||
|
||||
If you spot a plugin (or several) that you would like to use with Oh My Zsh, you will need to edit the `~/.zshrc` file. Once you open it with your favorite editor, you'll see a spot to list all the plugins that you'd like Oh My Zsh to load in initialization.
|
||||
|
||||
For example, this line might begin to look like...
|
||||
|
||||
`plugins=(git bundler osx rake ruby)`
|
||||
|
||||
#### Using Plugins
|
||||
|
||||
Most plugins (should! we're working on this) include a __README__, which documents how to use them.
|
||||
|
||||
### Themes
|
||||
|
||||
We'll admit it. Early in the Oh My Zsh world... we may have gotten a far too theme happy. We have over one hundred themes now bundled. Most of them have [screenshots](https://wiki.github.com/robbyrussell/oh-my-zsh/themes) on the wiki. Check them out!
|
||||
|
||||
#### Selecting a Theme
|
||||
|
||||
_Robby's theme is the default one. It's not the fanciest one. It's not the simplest one. It's just right (for him)._
|
||||
|
||||
Once you find a theme that you want to use, you will need to edit the `~/.zshrc` file. You'll see an environment variable (all caps) in there that looks like:
|
||||
|
||||
`ZSH_THEME="robbyrussell"`
|
||||
|
||||
To use a different theme, simple change the value to match the name of your desired theme. For example:
|
||||
|
||||
`ZSH_THEME="agnoster"` (this is one of the fancy ones)
|
||||
|
||||
Open up a new terminal window and your prompt should look something like...
|
||||
|
||||
## Advanced Topics
|
||||
|
||||
If you're the type that likes to get their hands dirty... these sections might resonate.
|
||||
|
||||
### Advanced Installation
|
||||
|
||||
For those who want to install this manually and/or set custom paths.
|
||||
|
||||
#### Custom Directory
|
||||
|
||||
The default location is `~/.oh-my-zsh` (hidden in your home directory)
|
||||
|
||||
If you'd like to change the install directory with the `ZSH` environment variable, either by running `export ZSH=/your/path` before installing, or by 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`
|
||||
|
||||
#### Manual Installation
|
||||
|
||||
##### 1. Clone the repository:
|
||||
|
||||
`git clone git://github.com/robbyrussell/oh-my-zsh.git ~/.oh-my-zsh`
|
||||
|
||||
##### 2. *Optionally*, backup your existing @~/.zshrc@ file:
|
||||
|
||||
`cp ~/.zshrc ~/.zshrc.orig`
|
||||
|
||||
##### 3. Create a new zsh configuration file
|
||||
|
||||
You can create a new zsh config file by copying the template that we included for you.
|
||||
|
||||
`cp ~/.oh-my-zsh/templates/zshrc.zsh-template ~/.zshrc`
|
||||
|
||||
##### 4. Change your default shell
|
||||
|
||||
`chsh -s /bin/zsh`
|
||||
|
||||
##### 5. Initialize your new zsh configuration
|
||||
|
||||
Once you open up a new terminal window, it should load zsh with Oh My Zsh's configuration.
|
||||
|
||||
### Installation Problems
|
||||
|
||||
If you have any hiccups installing, here are a few common fixes.
|
||||
|
||||
* 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 the `ZSH` environment variable in `~/.zshrc`.
|
||||
|
||||
### Custom Plugins and Themes
|
||||
|
||||
If you want to override any of the default behaviors, just add a new file (ending in `.zsh`) in the `custom/` directory.
|
||||
|
||||
If you have many functions that go well together, you can put them as a `abcyzeae.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/`.
|
||||
|
||||
## Getting Updates
|
||||
|
||||
By default, you will be prompted to check for upgrades every few weeks. If you would like `oh-my-zsh` to automatically upgrade itself without prompting you, set the following in your `~/.zshrc`:
|
||||
|
||||
`DISABLE_UPDATE_PROMPT=true`
|
||||
|
||||
To disable automatic upgrades, set the following in your `~/.zshrc`:
|
||||
|
||||
`DISABLE_AUTO_UPDATE=true`
|
||||
|
||||
### Manual Updates
|
||||
|
||||
If you'd like to upgrade at any point in time (maybe someone just released a new plugin and you don't want to wait a week?)... you just need to run:
|
||||
|
||||
`upgrade_oh_my_zsh`
|
||||
|
||||
Magic!
|
||||
|
||||
## Uninstalling Oh My Zsh
|
||||
|
||||
Oh My Zsh isn't for everyone. We'll miss you, but we want to make this an easy breakup.
|
||||
|
||||
If you want to uninstall `oh-my-zsh`, just run `uninstall_oh_my_zsh` from the command-line. It will remove itself and revert your previous `bash` or `zsh` configuration.
|
||||
|
||||
## Contributing
|
||||
|
||||
I'm far from being a [Zsh](http://www.zsh.org/) 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!
|
||||
|
||||
We also need people to test out pull-requests. So take a look through [the open issues](https://github.com/robbyrussell/oh-my-zsh/issues) and help where you can.
|
||||
|
||||
### Do NOT Send Us Themes
|
||||
|
||||
We have (more than) enough themes for the time being. Please fork the project and add one in there – you can let people know how to grab it from there.
|
||||
|
||||
## Contributors
|
||||
|
||||
Oh My Zsh has a vibrant community of happy users and delightful contributors. Without all the time and help from our contributors, it wouldn't be so awesome.
|
||||
|
||||
Thank you so much!
|
||||
|
||||
## Follow Us
|
||||
|
||||
We have an [ohmyzsh](https://twitter.com/ohmyzsh) account. You should follow it.
|
||||
|
||||
## Merchandise
|
||||
|
||||
We have [stickers](http://shop.planetargon.com/products/ohmyzsh-stickers-set-of-3-stickers) and [shirts](http://shop.planetargon.com/products/ohmyzsh-t-shirts) for you to show off your love of Oh My Zsh. Again, this will help you become the talk of the town!
|
||||
|
||||
## LICENSE
|
||||
|
||||
Oh My Zsh is released under the [MIT license](https://github.com/robbyrussell/oh-my-zsh/blob/master/MIT-LICENSE.txt).
|
||||
111
README.textile
111
README.textile
|
|
@ -1,111 +0,0 @@
|
|||
!https://s3.amazonaws.com/ohmyzsh/oh-my-zsh-logo.png!
|
||||
|
||||
@oh-my-zsh@ is an open source, community-driven framework for managing your "Zsh":http://www.zsh.org/ configuration.
|
||||
|
||||
It comes bundled with a ton of helpful functions, helpers, plugins, themes, and a few things that make 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*.
|
||||
|
||||
If not already installed, you can install "Zsh":http://www.zsh.org/ using the command-line.
|
||||
|
||||
h3. The automatic installer… do you trust me?
|
||||
|
||||
You can install this via the command-line with either @curl@ or @wget@.
|
||||
|
||||
h4. via @curl@:
|
||||
|
||||
@curl -L https://raw.github.com/robbyrussell/oh-my-zsh/master/tools/install.sh | sh@
|
||||
|
||||
h4. via @wget@:
|
||||
|
||||
@wget --no-check-certificate https://raw.github.com/robbyrussell/oh-my-zsh/master/tools/install.sh -O - | sh@
|
||||
|
||||
h4. *Optionally*, 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 by 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. *Optionally*, backup your existing @~/.zshrc@ file:
|
||||
|
||||
@cp ~/.zshrc ~/.zshrc.orig@
|
||||
|
||||
3. Create a new "Zsh":http://www.zsh.org/ config file by copying the "Zsh":http://www.zsh.org/ template we've provided:
|
||||
|
||||
@cp ~/.oh-my-zsh/templates/zshrc.zsh-template ~/.zshrc@
|
||||
|
||||
4. Set "Zsh":http://www.zsh.org/ as your default shell:
|
||||
|
||||
@chsh -s /bin/zsh@
|
||||
|
||||
5. Start or restart "Zsh":http://www.zsh.org/ by opening a new command-line window.
|
||||
|
||||
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 the @ZSH@ environment variable in @~/.zshrc@.
|
||||
|
||||
h2. Usage
|
||||
|
||||
* enable the plugins you want in your @~/.zshrc@ (take a look at the @plugins/@ directory and the "wiki":https://github.com/robbyrussell/oh-my-zsh/wiki/Plugins to see what's available)
|
||||
** example: @plugins=(git osx ruby)@
|
||||
* theme support: change the @ZSH_THEME@ environment variable in @~/.zshrc@
|
||||
** take a look at the @themes/@ directory and the "wiki":https://wiki.github.com/robbyrussell/oh-my-zsh/themes to see what comes bundled with @oh-my-zsh@
|
||||
* & much, much more… take a look at the @lib/@ directory to see what @oh-my-zsh@ has to offer…
|
||||
|
||||
h2. Useful
|
||||
|
||||
The "refcard":http://www.bash2zsh.com/zsh_refcard/refcard.pdf is pretty useful for tips.
|
||||
|
||||
h3. Customization
|
||||
|
||||
If you want to override any of the default behaviors, just add a new file (ending in @.zsh@) in the @custom/@ directory.
|
||||
|
||||
If you have many functions that go well together, you can put them as a @*.plugin.zsh@ file in the @custom/plugins/@ directory and then enable this plugin (see '"Usage":https://github.com/robbyrussell/oh-my-zsh#usage' above).
|
||||
|
||||
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 upgrades. If you would like @oh-my-zsh@ to automatically upgrade itself without prompting you, set the following in your @~/.zshrc@:
|
||||
|
||||
@DISABLE_UPDATE_PROMPT=true@
|
||||
|
||||
To disable upgrades entirely, set the following in your @~/.zshrc@:
|
||||
|
||||
@DISABLE_AUTO_UPDATE=true@
|
||||
|
||||
To upgrade directly from the command-line, just run @upgrade_oh_my_zsh@.
|
||||
|
||||
h3. Uninstalling
|
||||
|
||||
If you want to uninstall @oh-my-zsh@, just run @uninstall_oh_my_zsh@ from the command-line and it'll remove itself and revert you to @bash@ (or your previous "Zsh":http://www.zsh.org/ configuration).
|
||||
|
||||
h2. Help out!
|
||||
|
||||
I'm far from being a "Zsh":http://www.zsh.org/ 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. (Don't) send us your theme (for now)!
|
||||
|
||||
-I'm hoping to collect a bunch of themes – 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
|
||||
|
||||
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!
|
||||
Loading…
Reference in a new issue