From 0a02a4794dcb89b7566f0ebe406fc91455afce7a Mon Sep 17 00:00:00 2001 From: ncanceill Date: Sat, 4 Apr 2015 13:06:04 +0200 Subject: [PATCH] readme textile->markdown --- README.markdown | 34 ++++++++++++++++++++++++++++++++++ README.textile | 33 --------------------------------- 2 files changed, 34 insertions(+), 33 deletions(-) create mode 100644 README.markdown delete mode 100644 README.textile diff --git a/README.markdown b/README.markdown new file mode 100644 index 000000000..516411181 --- /dev/null +++ b/README.markdown @@ -0,0 +1,34 @@ +![Oh My Zsh](https://s3.amazonaws.com/ohmyzsh/oh-my-zsh-logo.png) + +This is a fork of [**@robbyrussell**](https://github.com/robbyrussell)'s original project. + +## Contributing + +You can [fetch](https://help.github.com/articles/fork-a-repo) this repository in order to [participate in testing](#testing) or [aggregate pull requests](#updating) for upstream. + +## Branches + +There are various branches used to help with maintenance. + +You are on the **master** branch. I use it for my own OMZ installs, it is usually pretty close to upstream, you are welcome to take inspiration but I will not allow external changes. + +### Tracking + +The [**upstream-edge** branch](https://github.com/ncanceill/oh-my-zsh/tree/upstream-edge) tracks the bleeding edge upstream. It is used as a clean starting point for new Pull Requests. + +### Testing + +The [**upstream-test** branch](https://github.com/ncanceill/oh-my-zsh/tree/upstream-test) holds changes that need testing before merging. + +### Updating + +These branches are used to aggregate Pull Requests into categories. Please submit your PRs to these branches, if applicable, instead of sending them directly upstream. This allows to keep the original repository clean. + +#### Plugins + +- [**git**](https://github.com/ncanceill/oh-my-zsh/tree/plugin-git) -- [Submit PR](https://github.com/ncanceill/oh-my-zsh/pull/new/plugin-git) + +#### Other + +- [Easy-To-Merge](https://github.com/ncanceill/oh-my-zsh/tree/easymerge) -- [Submit PR](https://github.com/ncanceill/oh-my-zsh/pull/new/easymerge) + diff --git a/README.textile b/README.textile deleted file mode 100644 index e32a8cf97..000000000 --- a/README.textile +++ /dev/null @@ -1,33 +0,0 @@ -!https://s3.amazonaws.com/ohmyzsh/oh-my-zsh-logo.png! - -This is a fork of ["@robbyrussell":https://github.com/robbyrussell]'s original project. - -h2. Contributing - -You can "fetch":https://help.github.com/articles/fork-a-repo this repository in order to ["participate in testing":#testing] or ["aggregate pull requests":#updating] for upstream. - -h2. Branches - -There are various branches used to help with maintenance. - -You are on the @master@ branch. I use it for my own OMZ installs, it is usually pretty close to upstream, you are welcome to take inspiration but I will not allow external changes. - -h3. Tracking - -The "@upstream-edge@ branch":https://github.com/ncanceill/oh-my-zsh/tree/upstream-edge tracks the bleeding edge upstream. It is used as a clean starting point for new Pull Requests. - -h3. Testing - -The "@upstream-test@ branch":https://github.com/ncanceill/oh-my-zsh/tree/upstream-test holds changes that need testing before merging. - -h3. Updating - -These branches are used to aggregate Pull Requests into categories. Please submit your PRs to these branches, if applicable, instead of sending them directly upstream. This allows to keep the original repository clean. - -h4. Plugins - -* "@git@":https://github.com/ncanceill/oh-my-zsh/tree/plugin-git -- "Submit PR":https://github.com/ncanceill/oh-my-zsh/pull/new/plugin-git - -h4. Other - -* "Easy-To-Merge":https://github.com/ncanceill/oh-my-zsh/tree/easymerge -- "Submit PR":https://github.com/ncanceill/oh-my-zsh/pull/new/easymerge