diff --git a/README.rst b/README.rst --- a/README.rst +++ b/README.rst @@ -5,18 +5,18 @@ RhodeCode About ----- -``RhodeCode`` is a fast and powerful management tool for Mercurial_ and GIT_ +``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. -It works on http/https and has a built in permission/authentication system with +It works on http/https and has a built in permission/authentication system with the ability to authenticate via LDAP or ActiveDirectory. RhodeCode also provides simple API so it's easy integrable with existing external systems. -RhodeCode is similar in some respects to github_ or bitbucket_, +RhodeCode is similar in some respects to github_ or bitbucket_, however RhodeCode can be run as standalone hosted application on your own server. -It is open source and donation ware and focuses more on providing a customized, -self administered interface for Mercurial_ and GIT_ repositories. -RhodeCode works on \*nix systems and Windows it is powered by a vcs_ library -that Lukasz Balcerzak and Marcin Kuzminski created to handle multiple +It is open source and donation ware and focuses more on providing a customized, +self administered interface for Mercurial_ and GIT_ repositories. +RhodeCode works on \*nix systems and Windows it is powered by a vcs_ library +that Lukasz Balcerzak and Marcin Kuzminski created to handle multiple different version control systems. RhodeCode uses `PEP386 versioning `_ @@ -29,7 +29,7 @@ Stable releases of RhodeCode are best in Or:: - pip install rhodecode + pip install rhodecode Detailed instructions and links may be found on the Installation page. @@ -51,7 +51,7 @@ Source code ----------- The latest sources can be obtained from official RhodeCode instance -https://secure.rhodecode.org +https://secure.rhodecode.org MIRRORS: @@ -68,7 +68,7 @@ https://github.com/marcinkuzminski/rhode RhodeCode Features ------------------ -- Has its own middleware to handle mercurial_ and git_ protocol requests. +- Has its own middleware to handle mercurial_ and git_ protocol requests. Each request is authenticated and logged together with IP address. - Build for speed and performance. You can make multiple pulls/pushes simultaneous. Proven to work with 1000s of repositories and users @@ -86,41 +86,41 @@ RhodeCode Features changeset statuses, and notification system. - Importing and syncing repositories from remote locations for GIT_, Mercurial_ and SVN. - Mako templates let's you customize the look and feel of the application. -- Beautiful diffs, annotations and source code browsing all colored by pygments. +- Beautiful diffs, annotations and source code browsing all colored by pygments. Raw diffs are made in git-diff format for both VCS systems, including GIT_ binary-patches - Mercurial_ and Git_ DAG graphs and yui-flot powered graphs with zooming and statistics to track activity for repositories - Admin interface with user/permission management. Admin activity journal, logs pulls, pushes, forks, registrations and other actions made by all users. -- Server side forks. It is possible to fork a project and modify it freely +- Server side forks. It is possible to fork a project and modify it freely without breaking the main repository. -- rst and markdown README support for repositories. +- rst and markdown README support for repositories. - Full text search powered by Whoosh on the source files, commit messages, and file names. Build in indexing daemons, with optional incremental index build (no external search servers required all in one application) -- Setup project descriptions/tags and info inside built in db for easy, non +- Setup project descriptions/tags and info inside built in db for easy, non file-system operations. -- Intelligent cache with invalidation after push or project change, provides +- Intelligent cache with invalidation after push or project change, provides high performance and always up to date data. - RSS / Atom feeds, gravatar support, downloadable sources as zip/tar/gz -- Optional async tasks for speed and performance using celery_ -- Backup scripts can do backup of whole app and send it over scp to desired - location +- Optional async tasks for speed and performance using celery_ +- Backup scripts can do backup of whole app and send it over scp to desired + location - Based on pylons / sqlalchemy / sqlite / whoosh / vcs - + Incoming / Plans ---------------- - Finer granular permissions per branch, or subrepo - Web based merges for pull requests - Tracking history for each lines in files -- Simple issue tracker +- Simple issue tracker - SSH based authentication with server side key management - Commit based built in wiki system - Gist server - More statistics and graph (global annotation + some more statistics) -- Other advancements as development continues (or you can of course make +- Other advancements as development continues (or you can of course make additions and or requests) License @@ -135,10 +135,10 @@ Getting help Listed bellow are various support resources that should help. .. note:: - + Please try to read the documentation before posting any issues, especially the **troubleshooting section** - + - Join the `Google group `_ and ask any questions. @@ -163,9 +163,9 @@ You may also build the documentation for make html (You need to have sphinx_ installed to build the documentation. If you don't -have sphinx_ installed you can install it via the command: +have sphinx_ installed you can install it via the command: ``easy_install sphinx``) - + .. _virtualenv: http://pypi.python.org/pypi/virtualenv .. _python: http://www.python.org/ .. _sphinx: http://sphinx.pocoo.org/ @@ -176,4 +176,4 @@ have sphinx_ installed you can install i .. _git: http://git-scm.com/ .. _celery: http://celeryproject.org/ .. _Sphinx: http://sphinx.pocoo.org/ -.. _vcs: http://pypi.python.org/pypi/vcs \ No newline at end of file +.. _vcs: http://pypi.python.org/pypi/vcs