new README, in preparation for rolling the new release into "master"

This commit is contained in:
Sitaram Chamarty 2012-04-05 19:18:53 +05:30
parent 8df28a02db
commit ecb172b785

32
README.mkd Normal file
View file

@ -0,0 +1,32 @@
# Gitolite README
**Github users: please read the "wiki" link at the top of the page before
submitting issues or pull requests**.
----
If you're reading this on the main gitolite page on github, several
**IMPORTANT CHANGES** have happened to gitolite:
1. A competely re-written version of gitolite has been pushed to the "master"
branch, and is now the actively maintained and supported software. Do NOT
try to merge this with your old "master" branch!
2. Versions v2.x is on branch "g2". It will be supported for security issues
and serious bugs in core functionality, but not for anything less
critical. Versions v1.x are completely unsupported now.
If you're an existing (v1.x, v2.x) gitolite user please spend some time with
the documentation for the new version before upgrading. The [main page][h-mp]
leads to quick install as well as several other useful starting points. The
[table of contents][h-mt] is a much more meaningfully ordered/structured list
of links (instead of putting them in alphabetical order of the filename, like
in g2!)
[h-mp]: http://sitaramc.github.com/gitolite/
[h-mt]: http://sitaramc.github.com/gitolite/master-toc.html
----
License information for code and documentation is at the end of doc/index.mkd
(or you can read it online [here][license]).