diff --git a/README.rst b/README.rst --- a/README.rst +++ b/README.rst @@ -1,6 +1,9 @@ -======================== -RhodeCode documentation! -======================== +========= +RhodeCode +========= + +About +----- ``RhodeCode`` is a fast and powerful management tool for Mercurial_ and GIT_ with a built in push/pull server and full text search and code-review. @@ -17,6 +20,21 @@ handle multiple different version contro RhodeCode uses `Semantic Versioning `_ +Installation +------------ +Stable releases of RhodeCode are best installed via:: + + easy_install rhodecode + +Or:: + + pip install rhodecode + +Detailed instructions and links may be found on the Installation page. + +Please visit http://packages.python.org/RhodeCode/installation.html for +more details + RhodeCode demo -------------- @@ -45,11 +63,6 @@ Sources at github_ https://github.com/marcinkuzminski/rhodecode -Installation ------------- - -Please visit http://packages.python.org/RhodeCode/installation.html - RhodeCode Features ------------------ @@ -91,9 +104,6 @@ RhodeCode Features location - Based on pylons / sqlalchemy / sqlite / whoosh / vcs - -.. include:: ./docs/screenshots.rst - Incoming / Plans ---------------- @@ -113,21 +123,35 @@ License ``RhodeCode`` is released under the GPLv3 license. -Mailing group Q&A ------------------ +Getting help +------------ -Join the `Google group `_ +Listed bellow are various support resources that should help. -Open an issue at `issue tracker `_ +.. note:: + + Please try to read the documentation before posting any issues + +- Join the `Google group `_ and ask + any questions. -Join #rhodecode on FreeNode (irc.freenode.net) -or use http://webchat.freenode.net/?channels=rhodecode for web access to irc. +- Open an issue at `issue tracker `_ + + +- Join #rhodecode on FreeNode (irc.freenode.net) + or use http://webchat.freenode.net/?channels=rhodecode for web access to irc. + +- You can also follow me on twitter @marcinkuzminski where i often post some + news about RhodeCode + Online documentation -------------------- Online documentation for the current version of RhodeCode is available at -http://packages.python.org/RhodeCode/. + - http://packages.python.org/RhodeCode/ + - http://rhodecode.readthedocs.org/en/latest/index.html + You may also build the documentation for yourself - go into ``docs/`` and run:: make html