diff --git a/README.rst b/README.rst --- a/README.rst +++ b/README.rst @@ -1,23 +1,25 @@ -RhodeCode (RhodiumCode) -======================= +================================================= +Welcome to RhodeCode (RhodiumCode) documentation! +================================================= -``RhodeCode`` (formerly hg-app) is Pylons based repository management and -serving for mercurial_. It's similar to github or bitbucket, but it's suppose to run -as standalone app, it's open source and focuses more on restricted access to repositories -There's no default free access to RhodeCode You have to create an account in order -to use the application. It's powered by vcs_ library that we created to handle -many various version control systems. +``RhodeCode`` (formerly hg-app) is Pylons framework based Mercurial repository +browser/management with build in push/pull server and full text search. +It works on http/https, has build in permission/authentication(+ldap) features +It's similar to github or bitbucket, but it's suppose to run as standalone +hosted application, it's open source and focuses more on restricted access to +repositories. It's powered by vcs_ library that me and Lukasz Balcerzak created +to handle many various version control systems. RhodeCode uses `Semantic Versioning `_ - RhodeCode demo -------------- http://hg.python-works.com -The default access is +The default access is anonymous but You can login to administrative account +using those credentials - username: demo - password: demo @@ -25,14 +27,14 @@ The default access is Source code ----------- -Source code is along with issue tracker is available at +The most up to date sources can be obtained from my own RhodeCode instance +https://rhodecode.org + +Rarely updated source code and issue tracker is available at bitbcuket http://bitbucket.org/marcinkuzminski/rhodecode -Also a source codes can be obtained from demo rhodecode instance -http://hg.python-works.com/rhodecode/summary - -Instalation ------------ +Installation +------------ Please visit http://packages.python.org/RhodeCode/installation.html @@ -40,41 +42,49 @@ Instalation Features -------- -- Has it's own middleware to handle mercurial_ protocol request. Each request - can be logged and authenticated. Runs on threads unlikely to hgweb You can - make multiple pulls/pushes simultaneous. Supports http/https -- Full permissions and authentication per project private/read/write/admin. - One account for web interface and mercurial_ push/pull/clone. +- Has it's own middleware to handle mercurial_ protocol request. + Each request can be logged and authenticated. Runs on threads unlikely to + hgweb. You can make multiple pulls/pushes simultaneous. Supports http/https + and ldap +- Full permissions (private/read/write/admin) and authentication per project. + One account for web interface and mercurial_ push/pull/clone operations. - Mako templates let's you customize look and feel of application. - Beautiful diffs, annotations and source codes all colored by pygments. - Mercurial_ branch graph and yui-flot powered graphs with zooming and statistics -- Admin interface with user/permission management. User activity journal logs - pulls, pushes, forks,registrations. Possible to disable built in hooks +- 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's possible to fork a project and hack it free without - breaking the main. -- Full text search on source codes, search on file names. All powered by whoosh - and build in indexing daemons + breaking the main repository. +- Full text search powered by Whoosh on source codes, and file names. + Build in indexing daemons, with optional incremental index build (no external search servers required all in one application) -- Rss / atom feeds, gravatar support, download sources as zip/tarballs +- Setup project descriptions and info inside built in db for easy, non + file-system operations +- Inteligent cache with invalidation after push or project change, provides high + performance and always up to date data. +- Rss / atom feeds, gravatar support, download sources as zip/tar/gz - Async tasks for speed and performance using celery_ (works without them too) - Backup scripts can do backup of whole app and send it over scp to desired - location -- Setup project descriptions and info inside built in db for easy, non - file-system operations -- Added cache with invalidation on push/repo management for high performance and - always up to date data. -- Based on pylons 1.0 / sqlalchemy 0.6 / sqlite + location +- Based on pylons / sqlalchemy / sqlite / whoosh / vcs -Incoming --------- +.. include:: ./docs/screenshots.rst + + +Incoming / Plans +---------------- +- project grouping +- User groups/teams - code review (probably based on hg-review) -- full git_ support, with push/pull server +- full git_ support, with push/pull server (currently in beta tests) +- redmine integration +- public accessible activity feeds - commit based build in wiki system - clone points and cloning from remote repositories into rhodecode (git_ and mercurial_) -- some cache optimizations +- more statistics and graph (global annotation + some more statistics) - other cools stuff that i can figure out (or You can help me figure out) License @@ -83,8 +93,18 @@ License ``rhodecode`` is released under GPL_ license. -Documentation -------------- +Mailing group Q&A +----------------- + +join the `Google group `_ + +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. + +Online documentation +-------------------- Online documentation for current version is available at http://packages.python.org/RhodeCode/. @@ -92,13 +112,3 @@ Documentation make html -.. _virtualenv: http://pypi.python.org/pypi/virtualenv -.. _python: http://www.python.org/ -.. _django: http://www.djangoproject.com/ -.. _mercurial: http://mercurial.selenic.com/ -.. _subversion: http://subversion.tigris.org/ -.. _git: http://git-scm.com/ -.. _celery: http://celeryproject.org/ -.. _Sphinx: http://sphinx.pocoo.org/ -.. _GPL: http://www.gnu.org/licenses/gpl.html -.. _vcs: http://pypi.python.org/pypi/vcs \ No newline at end of file