linux/ohmyzsh
1
0
Fork 0
mirror of https://github.com/ohmyzsh/ohmyzsh.git synced 2026-03-20 03:13:33 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

readme textile->markdown

Browse source
This commit is contained in:
ncanceill 2015-04-04 13:06:04 +02:00
commit 0a02a4794d
2 changed files with 34 additions and 33 deletions
Download patch file Download diff file Expand all files Collapse all files

34
README.markdown Normal file
View file

@ -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)

33
README.textile
View file

@ -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