`8f1741d56c21f1daf50c1e1f76a5eea37106e239`

Author: Robby Russell <robby@planetargon.com>
Committer: Robby Russell <robby@planetargon.com>
Date: 2015-02-22 00:07 UTC

Message

Moving README to markdown... and taking first steps at reorganizing it. Also updated the LICENSE to reflect 2015.

Diff

This diff is truncated to protect this page.

  1diff --git a/MIT-LICENSE.txt b/MIT-LICENSE.txt
  2index 6eb8aab34f66de325a336c327b9abb1b476e6ad3..dfbd90035cc448b0c75d935ef98d2144cf49fc84 100644
  3--- a/MIT-LICENSE.txt
  4+++ b/MIT-LICENSE.txt
  5@@ -1,6 +1,6 @@
  6 The MIT License
  7 
  8-Copyright (c) 2009-2014 Robby Russell and contributors (see https://github.com/robbyrussell/oh-my-zsh/contributors)
  9+Copyright (c) 2009-2015 Robby Russell and contributors (see https://github.com/robbyrussell/oh-my-zsh/contributors)
 10 
 11 Permission is hereby granted, free of charge, to any person obtaining a copy
 12 of this software and associated documentation files (the "Software"), to deal
 13diff --git a/README.markdown b/README.markdown
 14new file mode 100644
 15index 0000000000000000000000000000000000000000..1a8e6f8d0f9672ebd0e8b332d889848982ebbe61
 16--- /dev/null
 17+++ b/README.markdown
 18@@ -0,0 +1,175 @@
 19+![Oh My Zsh](https://s3.amazonaws.com/ohmyzsh/oh-my-zsh-logo.png)
 20+
 21+
 22+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.
 23+
 24diff --git a/README.textile b/README.textile
 25deleted file mode 100644
 26index d09e6b4bd48425ef901c8b95b5e73a22aee8f3f1..0000000000000000000000000000000000000000
 27--- a/README.textile
 28+++ /dev/null
 29@@ -1,111 +0,0 @@
 30-!https://s3.amazonaws.com/ohmyzsh/oh-my-zsh-logo.png!
 31-
 32-@oh-my-zsh@ is an open source, community-driven framework for managing your "Zsh":http://www.zsh.org/ configuration.
 33-
 34-It comes bundled with a ton of helpful functions, helpers, plugins, themes, and a few things that make you shout…
 35-
 36-bq. "OH MY ZSHELL!"
 37-
 38-h2. Setup
 39-
 40-@oh-my-zsh@ should work with any recent release of "Zsh":http://www.zsh.org/. The minimum recommended version is *4.3.9*.
 41-
 42-If not already installed, you can install "Zsh":http://www.zsh.org/ using the command-line.
 43-
 44-h3. The automatic installer… do you trust me?
 45-
 46-You can install this via the command-line with either @curl@ or @wget@.
 47-
 48-h4. via @curl@:
 49-
 50-@curl -L https://raw.github.com/robbyrussell/oh-my-zsh/master/tools/install.sh | sh@
 51-
 52-h4. via @wget@:
 53-
 54-@wget --no-check-certificate https://raw.github.com/robbyrussell/oh-my-zsh/master/tools/install.sh -O - | sh@
 55-
 56-h4. *Optionally*, change the install directory:
 57-
 58-The default location is @~/.oh-my-zsh@ (hidden in your home directory).
 59-
 60-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:
 61-
 62-@curl -L https://raw.github.com/robbyrussell/oh-my-zsh/master/tools/install.sh | ZSH=~/.dotfiles/zsh sh@
 63-
 64-h3. The manual way
 65-
 66-1. Clone the repository:
 67-
 68-@git clone git://github.com/robbyrussell/oh-my-zsh.git ~/.oh-my-zsh@
 69-
 70-2. *Optionally*, backup your existing @~/.zshrc@ file:
 71-
 72-@cp ~/.zshrc ~/.zshrc.orig@
 73-
 74-3. Create a new "Zsh":http://www.zsh.org/ config file by copying the "Zsh":http://www.zsh.org/ template we've provided:
 75-
 76-@cp ~/.oh-my-zsh/templates/zshrc.zsh-template ~/.zshrc@
 77-
 78-4. Set "Zsh":http://www.zsh.org/ as your default shell:
 79-
 80-@chsh -s /bin/zsh@
 81-
 82-5. Start or restart "Zsh":http://www.zsh.org/ by opening a new command-line window.
 83-
 84-h3. Problems?
 85-
 86-You _might_ need to modify your @PATH@ in @~/.zshrc@ if you're not able to find some commands after switching to @oh-my-zsh@.
 87-
 88-If you installed manually or changed the install location, check the @ZSH@ environment variable in @~/.zshrc@.
 89-
 90-h2. Usage
 91-
 92-* 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)
 93-** example: @plugins=(git osx ruby)@
 94-* theme support: change the @ZSH_THEME@ environment variable in @~/.zshrc@
 95-** 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@
 96-* & much, much more… take a look at the @lib/@ directory to see what @oh-my-zsh@ has to offer…
 97-
 98-h2. Useful
 99-
100-The "refcard":http://www.bash2zsh.com/zsh_refcard/refcard.pdf is pretty useful for tips.
101-
102-h3. Customization
103-
104-If you want to override any of the default behaviors, just add a new file (ending in @.zsh@) in the @custom/@ directory.
105-
106-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).
107-
108-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/@.
109-
110-h3. Updates
111-
112-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@:
113-
114-@DISABLE_UPDATE_PROMPT=true@
115-
116-To disable upgrades entirely, set the following in your @~/.zshrc@:
117-
118-@DISABLE_AUTO_UPDATE=true@
119-
120-To upgrade directly from the command-line, just run @upgrade_oh_my_zsh@.
121-
122-h3. Uninstalling
123-
124-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).
125-
126-h2. Help out!
127-
128-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!