Oh My Zsh is an open source, community-driven framework for managing your [zsh](https://www.zsh.org/) configuration.
Oh My Zsh is an open source, community-driven framework for managing your [zsh](https://www.zsh.org/) configuration.
Sounds boring. Let's try again.
Sounds boring. Let's try again.
...
@@ -19,7 +22,7 @@ To learn more, visit [ohmyz.sh](https://ohmyz.sh) and follow [@ohmyzsh](https://
...
@@ -19,7 +22,7 @@ To learn more, visit [ohmyz.sh](https://ohmyz.sh) and follow [@ohmyzsh](https://
### Prerequisites
### Prerequisites
* A Unix-like operating system: macOS, Linux, BSD. On Windows: WSL is preferred, but cygwin or msys also mostly work.
* A Unix-like operating system: macOS, Linux, BSD. On Windows: WSL is preferred, but cygwin or msys also mostly work.
*[Zsh](https://www.zsh.org) should be installed (v4.3.9 or more recent). If not pre-installed (run `zsh --version` to confirm), check the following instructions here: [Installing ZSH](https://github.com/robbyrussell/oh-my-zsh/wiki/Installing-ZSH)
*[Zsh](https://www.zsh.org) should be installed (v4.3.9 or more recent). If not pre-installed (run `zsh --version` to confirm), check the following instructions here: [Installing ZSH](https://github.com/ohmyzsh/ohmyzsh/wiki/Installing-ZSH)
*`curl` or `wget` should be installed
*`curl` or `wget` should be installed
*`git` should be installed
*`git` should be installed
...
@@ -30,13 +33,13 @@ Oh My Zsh is installed by running one of the following commands in your terminal
...
@@ -30,13 +33,13 @@ Oh My Zsh is installed by running one of the following commands in your terminal
#### via curl
#### via curl
```shell
```shell
sh -c"$(curl -fsSL https://raw.githubusercontent.com/robbyrussell/oh-my-zsh/master/tools/install.sh)"
sh -c"$(curl -fsSL https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh)"
```
```
#### via wget
#### via wget
```shell
```shell
sh -c"$(wget -O- https://raw.githubusercontent.com/robbyrussell/oh-my-zsh/master/tools/install.sh)"
sh -c"$(wget -O- https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh)"
```
```
#### Manual inspection
#### Manual inspection
...
@@ -46,7 +49,7 @@ that by downloading the install script first, looking through it so everything l
...
@@ -46,7 +49,7 @@ that by downloading the install script first, looking through it so everything l
Oh My Zsh comes with a shitload 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.
Oh My Zsh comes with a shitload of plugins to take advantage of. You can take a look in the [plugins](https://github.com/ohmyzsh/ohmyzsh/tree/master/plugins) directory and/or the [wiki](https://github.com/ohmyzsh/ohmyzsh/wiki/Plugins) to see what's currently available.
#### Enabling Plugins
#### Enabling Plugins
...
@@ -86,7 +89,7 @@ Most plugins (should! we're working on this) include a __README__, which documen
...
@@ -86,7 +89,7 @@ Most plugins (should! we're working on this) include a __README__, which documen
### Themes
### Themes
We'll admit it. Early in the Oh My Zsh world, we may have gotten a bit too theme happy. We have over one hundred themes now bundled. Most of them have [screenshots](https://github.com/robbyrussell/oh-my-zsh/wiki/Themes) on the wiki. Check them out!
We'll admit it. Early in the Oh My Zsh world, we may have gotten a bit too theme happy. We have over one hundred themes now bundled. Most of them have [screenshots](https://github.com/ohmyzsh/ohmyzsh/wiki/Themes) on the wiki. Check them out!
#### Selecting a Theme
#### Selecting a Theme
...
@@ -102,7 +105,7 @@ To use a different theme, simply change the value to match the name of your desi
...
@@ -102,7 +105,7 @@ To use a different theme, simply change the value to match the name of your desi
```shell
```shell
ZSH_THEME="agnoster"# (this is one of the fancy ones)
ZSH_THEME="agnoster"# (this is one of the fancy ones)
# see https://github.com/robbyrussell/oh-my-zsh/wiki/Themes#agnoster
# see https://github.com/ohmyzsh/ohmyzsh/wiki/Themes#agnoster
```
```
_Note: many themes require installing the [Powerline Fonts](https://github.com/powerline/fonts) in order to render properly._
_Note: many themes require installing the [Powerline Fonts](https://github.com/powerline/fonts) in order to render properly._
...
@@ -111,7 +114,7 @@ Open up a new terminal window and your prompt should look something like this:
...
@@ -111,7 +114,7 @@ Open up a new terminal window and your prompt should look something like this:
In case you did not find a suitable theme for your needs, please have a look at the wiki for [more of them](https://github.com/robbyrussell/oh-my-zsh/wiki/External-themes).
In case you did not find a suitable theme for your needs, please have a look at the wiki for [more of them](https://github.com/ohmyzsh/ohmyzsh/wiki/External-themes).
If you're feeling feisty, you can let the computer select one randomly for you each time you open a new terminal window.
If you're feeling feisty, you can let the computer select one randomly for you each time you open a new terminal window.
...
@@ -157,14 +160,14 @@ flag `--unattended` to the `install.sh` script. This will have the effect of not
...
@@ -157,14 +160,14 @@ flag `--unattended` to the `install.sh` script. This will have the effect of not
the default shell, and also won't run `zsh` when the installation has finished.
the default shell, and also won't run `zsh` when the installation has finished.
```shell
```shell
sh -c"$(curl -fsSL https://raw.githubusercontent.com/robbyrussell/oh-my-zsh/master/tools/install.sh)"""--unattended
sh -c"$(curl -fsSL https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh)"""--unattended
```
```
#### Installing from a forked repository
#### Installing from a forked repository
The install script also accepts these variables to allow installation of a different repository:
The install script also accepts these variables to allow installation of a different repository:
-`REPO` (default: `robbyrussell/oh-my-zsh`): this takes the form of `owner/repository`. If you set
-`REPO` (default: `ohmyzsh/ohmyzsh`): this takes the form of `owner/repository`. If you set
this variable, the installer will look for a repository at `https://github.com/{owner}/{repository}`.
this variable, the installer will look for a repository at `https://github.com/{owner}/{repository}`.
-`REMOTE` (default: `https://github.com/${REPO}.git`): this is the full URL of the git repository
-`REMOTE` (default: `https://github.com/${REPO}.git`): this is the full URL of the git repository
...
@@ -188,7 +191,7 @@ REPO=apjanke/oh-my-zsh BRANCH=edge sh install.sh
...
@@ -188,7 +191,7 @@ REPO=apjanke/oh-my-zsh BRANCH=edge sh install.sh
##### 2. *Optionally*, backup your existing `~/.zshrc` file:
##### 2. *Optionally*, backup your existing `~/.zshrc` file:
...
@@ -270,13 +273,13 @@ Before you participate in our delightful community, please read the [code of con
...
@@ -270,13 +273,13 @@ Before you participate in our delightful community, please read the [code of con
I'm far from being a [Zsh](https://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!
I'm far from being a [Zsh](https://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.
We also need people to test out pull-requests. So take a look through [the open issues](https://github.com/ohmyzsh/ohmyzsh/issues) and help where you can.
See [Contributing](CONTRIBUTING.md) for more details.
See [Contributing](CONTRIBUTING.md) for more details.
### Do NOT send us themes
### Do NOT send us themes
We have (more than) enough themes for the time being. Please add your theme to the [external themes](https://github.com/robbyrussell/oh-my-zsh/wiki/External-themes) wiki page.
We have (more than) enough themes for the time being. Please add your theme to the [external themes](https://github.com/ohmyzsh/ohmyzsh/wiki/External-themes) wiki page.
@@ -42,7 +42,7 @@ This will exclude the `foreman` and `spin` gems (i.e. their executable) from bei
...
@@ -42,7 +42,7 @@ This will exclude the `foreman` and `spin` gems (i.e. their executable) from bei
## Excluded gems
## Excluded gems
These gems should not be called with `bundle exec`. Please see [issue #2923](https://github.com/robbyrussell/oh-my-zsh/pull/2923) on GitHub for clarification.
These gems should not be called with `bundle exec`. Please see [issue #2923](https://github.com/ohmyzsh/ohmyzsh/pull/2923) on GitHub for clarification.