From 8f1741d56c21f1daf50c1e1f76a5eea37106e239 Mon Sep 17 00:00:00 2001 From: Robby Russell Date: Sat, 21 Feb 2015 16:07:27 -0800 Subject: Moving README to markdown... and taking first steps at reorganizing it. Also updated the LICENSE to reflect 2015. --- README.markdown | 175 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 175 insertions(+) create mode 100644 README.markdown (limited to 'README.markdown') diff --git a/README.markdown b/README.markdown new file mode 100644 index 000000000..1a8e6f8d0 --- /dev/null +++ b/README.markdown @@ -0,0 +1,175 @@ +![Oh My Zsh](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. 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). -- cgit v1.2.3-70-g09d2 From caac64cf37912f37d85c7eb8fa6e053ceb7d2151 Mon Sep 17 00:00:00 2001 From: Robby Russell Date: Sat, 21 Feb 2015 16:11:57 -0800 Subject: Few copy edits to README --- README.markdown | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'README.markdown') diff --git a/README.markdown b/README.markdown index 1a8e6f8d0..40f5e661c 100644 --- a/README.markdown +++ b/README.markdown @@ -3,14 +3,14 @@ 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. +__Oh My Zsh is a way of life!__ Once installed, your terminal prompt will become the talk of the town _or your money back!_ Each time you interace with your command prompt, you'll be able 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 +### Prerequisites __Disclaimer:__ _Oh My Zsh works best on Mac OS X and Linux._ -- cgit v1.2.3-70-g09d2 From 5cd31822c72964b19b6c1938694697726b2ac3b9 Mon Sep 17 00:00:00 2001 From: Robby Russell Date: Sat, 21 Feb 2015 16:13:53 -0800 Subject: Missed a few textile formatting spots --- README.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.markdown') diff --git a/README.markdown b/README.markdown index 40f5e661c..8fa0de46b 100644 --- a/README.markdown +++ b/README.markdown @@ -21,7 +21,7 @@ __Disclaimer:__ _Oh My Zsh works best on Mac OS X and Linux._ ### 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@. +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 -- cgit v1.2.3-70-g09d2 From a1de65e3595c9bc3438b98d9ca671c2890a4b613 Mon Sep 17 00:00:00 2001 From: Robby Russell Date: Sat, 21 Feb 2015 16:19:22 -0800 Subject: Removing --no-check-certificate from README --- README.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.markdown') diff --git a/README.markdown b/README.markdown index 8fa0de46b..25bcdbe6e 100644 --- a/README.markdown +++ b/README.markdown @@ -29,7 +29,7 @@ Oh My Zsh is installed by running one of the following commands in your terminal #### via wget -`wget --no-check-certificate https://raw.github.com/robbyrussell/oh-my-zsh/master/tools/install.sh -O - | sh` +`wget https://raw.github.com/robbyrussell/oh-my-zsh/master/tools/install.sh -O - | sh` ## Using Oh My Zsh -- cgit v1.2.3-70-g09d2 From d4918ae8a096545d0135e3f001bc1195c0a365fe Mon Sep 17 00:00:00 2001 From: Nathan Daly Date: Fri, 27 Mar 2015 15:59:53 -0700 Subject: Fixed Typo. --- README.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.markdown') diff --git a/README.markdown b/README.markdown index 25bcdbe6e..9f96e315d 100644 --- a/README.markdown +++ b/README.markdown @@ -3,7 +3,7 @@ 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 _or your money back!_ Each time you interace with your command prompt, you'll be able 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. +__Oh My Zsh is a way of life!__ Once installed, your terminal prompt will become the talk of the town _or your money back!_ Each time you interface with your command prompt, you'll be able 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. -- cgit v1.2.3-70-g09d2 From 23ac32d34680785c678ee64a915d11e12253d206 Mon Sep 17 00:00:00 2001 From: Martin Delille Date: Mon, 30 Mar 2015 11:23:00 +0200 Subject: add help link to install zsh --- README.markdown | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) (limited to 'README.markdown') diff --git a/README.markdown b/README.markdown index 9f96e315d..4723d3486 100644 --- a/README.markdown +++ b/README.markdown @@ -15,8 +15,7 @@ To learn more, visit http://ohmyz.sh and/or follow [ohmyzsh](https://twitter.com __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) +* [Zsh](http://www.zsh.org) should be installed (v4.3.9 or more recent). If not pre-installed (`zsh --version` to confirm), check the following instruction here: [Installing-ZSH](https://github.com/robbyrussell/oh-my-zsh/wiki/Installing-ZSH) * `curl` or `wget` should be installed ### Basic Installation -- cgit v1.2.3-70-g09d2 From 4ab430025c97902a28c0fa7aad45e14d0a7852e9 Mon Sep 17 00:00:00 2001 From: Kevin Ndung'u Date: Sat, 18 Apr 2015 15:47:08 +0300 Subject: Add git to prerequisites Resolves #3786 --- README.markdown | 1 + 1 file changed, 1 insertion(+) (limited to 'README.markdown') diff --git a/README.markdown b/README.markdown index 4723d3486..31cbc810b 100644 --- a/README.markdown +++ b/README.markdown @@ -17,6 +17,7 @@ __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). If not pre-installed (`zsh --version` to confirm), check the following instruction here: [Installing-ZSH](https://github.com/robbyrussell/oh-my-zsh/wiki/Installing-ZSH) * `curl` or `wget` should be installed +* `git` should be installed ### Basic Installation -- cgit v1.2.3-70-g09d2 From c838b9a112e1569bcc5af069d8283057f7d4208a Mon Sep 17 00:00:00 2001 From: Diego Rabatone Oliveira Date: Sat, 9 May 2015 17:38:34 -0300 Subject: Update README.markdown Updating the install instructions as proposed in: https://github.com/robbyrussell/oh-my-zsh/issues/3516#issuecomment-76506726 --- README.markdown | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'README.markdown') diff --git a/README.markdown b/README.markdown index 31cbc810b..88ef356fd 100644 --- a/README.markdown +++ b/README.markdown @@ -25,11 +25,11 @@ Oh My Zsh is installed by running one of the following commands in your terminal #### via curl -`curl -L https://raw.github.com/robbyrussell/oh-my-zsh/master/tools/install.sh | sh` +`sh -c "$(curl -fsSL https://raw.github.com/robbyrussell/oh-my-zsh/master/tools/install.sh)"` #### via wget -`wget https://raw.github.com/robbyrussell/oh-my-zsh/master/tools/install.sh -O - | sh` +`sh -c "$(wget https://raw.github.com/robbyrussell/oh-my-zsh/master/tools/install.sh -O -)"` ## Using Oh My Zsh -- cgit v1.2.3-70-g09d2 From 69dee6538155cb604434363ba243e540a6104fe6 Mon Sep 17 00:00:00 2001 From: asaph Date: Tue, 19 May 2015 13:24:16 -0700 Subject: Fixed typo in README --- README.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.markdown') diff --git a/README.markdown b/README.markdown index 88ef356fd..5d4819d76 100644 --- a/README.markdown +++ b/README.markdown @@ -51,7 +51,7 @@ Most plugins (should! we're working on this) include a __README__, which documen ### 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! +We'll admit it. Early in the Oh My Zsh world... we may have gotten 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 -- cgit v1.2.3-70-g09d2 From 3f9298514e22d6e5923f14f98b825f1688158781 Mon Sep 17 00:00:00 2001 From: Dominik Ritter Date: Mon, 25 May 2015 01:15:37 +0200 Subject: Added references to the `external themes` wiki page. --- README.markdown | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) (limited to 'README.markdown') diff --git a/README.markdown b/README.markdown index 5d4819d76..3805d1eb4 100644 --- a/README.markdown +++ b/README.markdown @@ -67,6 +67,8 @@ To use a different theme, simple change the value to match the name of your desi Open up a new terminal window and your prompt should look something like... +In case you did not find a suitable theme for your needs, please have a look at the wiki for [more themes](https://github.com/robbyrussell/oh-my-zsh/wiki/External-themes). + ## Advanced Topics If you're the type that likes to get their hands dirty... these sections might resonate. @@ -154,7 +156,7 @@ We also need people to test out pull-requests. So take a look through [the open ### 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. +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. ## Contributors -- cgit v1.2.3-70-g09d2 From b3ce0f36d61a1585c018d2d3602fae1d72e4b024 Mon Sep 17 00:00:00 2001 From: Qix Date: Sun, 1 Mar 2015 00:36:33 -0500 Subject: Update README.markdown A few spelling fixes, grammatical fixes (what's with all the ellipses?), some standardization of capitalization, and a few other tweaks. As well, I changed all standalone code fragments into proper code blocks. I also added a missing theme image! --- README.markdown | 70 ++++++++++++++++++++++++++++++++++++++------------------- 1 file changed, 47 insertions(+), 23 deletions(-) (limited to 'README.markdown') diff --git a/README.markdown b/README.markdown index 3805d1eb4..d4d3fdbaf 100644 --- a/README.markdown +++ b/README.markdown @@ -3,9 +3,9 @@ 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 _or your money back!_ Each time you interface with your command prompt, you'll be able 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. +__Oh My Zsh is a way of life!__ Once installed, your terminal prompt will become the talk of the town _or your money back!_ Each time you interact with your command prompt, you'll be able 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. +To learn more, visit http://ohmyz.sh and/or follow [ohmyzsh](https://twitter.com/ohmyzsh) on Twitter. ## Getting Started @@ -43,7 +43,9 @@ If you spot a plugin (or several) that you would like to use with Oh My Zsh, you For example, this line might begin to look like... -`plugins=(git bundler osx rake ruby)` +```shell +plugins=(git bundler osx rake ruby) +``` #### Using Plugins @@ -51,7 +53,7 @@ Most plugins (should! we're working on this) include a __README__, which documen ### Themes -We'll admit it. Early in the Oh My Zsh world... we may have gotten 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! +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://wiki.github.com/robbyrussell/oh-my-zsh/themes) on the wiki. Check them out! #### Selecting a Theme @@ -59,23 +61,29 @@ _Robby's theme is the default one. It's not the fanciest one. It's not the simpl 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"` +```shell +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) +```shell +ZSH_THEME="agnoster" # (this is one of the fancy ones) +``` Open up a new terminal window and your prompt should look something like... -In case you did not find a suitable theme for your needs, please have a look at the wiki for [more themes](https://github.com/robbyrussell/oh-my-zsh/wiki/External-themes). +![Agnoster theme](https://cloud.githubusercontent.com/assets/2618447/6316862/70f58fb6-ba03-11e4-82c9-c083bf9a6574.png) + +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). ## Advanced Topics -If you're the type that likes to get their hands dirty... these sections might resonate. +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. +Some users may want to change the default path, or manually install Oh My Zsh. #### Custom Directory @@ -83,27 +91,37 @@ 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` +```shell +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` +```shell +git clone git://github.com/robbyrussell/oh-my-zsh.git ~/.oh-my-zsh +``` -##### 2. *Optionally*, backup your existing @~/.zshrc@ file: +##### 2. *Optionally*, backup your existing `~/.zshrc` file: -`cp ~/.zshrc ~/.zshrc.orig` +```shell +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` +```shell +cp ~/.oh-my-zsh/templates/zshrc.zsh-template ~/.zshrc +``` ##### 4. Change your default shell -`chsh -s /bin/zsh` +```shell +chsh -s /bin/zsh +``` ##### 5. Initialize your new zsh configuration @@ -120,7 +138,7 @@ If you have any hiccups installing, here are a few common fixes. 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 have many functions that go well together, you can put them as a `XYZ.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/`. @@ -128,17 +146,23 @@ If you would like to override the functionality of a plugin distributed with Oh 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` +```shell +DISABLE_UPDATE_PROMPT=true +``` To disable automatic upgrades, set the following in your `~/.zshrc`: -`DISABLE_AUTO_UPDATE=true` +```shell +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: +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` +```shell +upgrade_oh_my_zsh +``` Magic! @@ -154,7 +178,7 @@ I'm far from being a [Zsh](http://www.zsh.org/) expert and suspect there are man 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 +### 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. @@ -166,12 +190,12 @@ Thank you so much! ## Follow Us -We have an [ohmyzsh](https://twitter.com/ohmyzsh) account. You should follow it. +We have an [@ohmyzsh](https://twitter.com/ohmyzsh) Twitter 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 +## License Oh My Zsh is released under the [MIT license](https://github.com/robbyrussell/oh-my-zsh/blob/master/MIT-LICENSE.txt). -- cgit v1.2.3-70-g09d2