diff README.rst @ 1062:053983a464e4 beta

docs and readme update
author Marcin Kuzminski <marcin@python-works.com>
date Thu, 17 Feb 2011 00:44:45 +0100
parents 0a099e4ad4bf
children 615c1bc11889
line wrap: on
line diff
--- a/README.rst	Thu Feb 17 00:43:39 2011 +0100
+++ b/README.rst	Thu Feb 17 00:44:45 2011 +0100
@@ -4,12 +4,14 @@
 =================================================
 
 ``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.
+browser/management tool with build in push/pull server and full text search.
+It works on http/https, has build in permission/authentication system with 
+ability to auth via LDAP. It's similar in some parts to github or bitbucket, 
+but it's suppose to run as standalone hosted application, it's open source 
+and donation ware and focuses more on providing customized, self administered 
+interface for Mercurial(and soon GIT) repositories. It's powered by vcs_ 
+library that me and Lukasz Balcerzak created to handle many various version 
+control systems.
 
 RhodeCode uses `Semantic Versioning <http://semver.org/>`_
 
@@ -45,23 +47,28 @@
 - 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
+  and LDAP
 - Full permissions (private/read/write/admin) and authentication per project. 
   One account for web interface and mercurial_ push/pull/clone operations.
+- Have built in users groups for easier permission management
+- Users can fork other users repo. RhodeCode have also compare view to see
+  combined changeset for all changeset made within single push.
 - Mako templates let's you customize look and feel of application.
-- Beautiful diffs, annotations and source codes all colored by pygments.
+- Beautiful diffs, annotations and source codes all colored by pygments. Raw
+  diffs are made in git-diff format, including git binary-patches
 - Mercurial_ branch graph and yui-flot powered graphs with zooming and statistics
 - 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 repository.
+  breaking the main repository. You can even write Your own hooks and install 
+  them
 - 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)
+  (no external search servers required. All in one application !)
 - Setup project descriptions and info inside built in db for easy, non 
   file-system operations
-- Intelligent cache with invalidation after push or project change, provides high 
-  performance and always up to date data.    
+- Intelligent 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 
@@ -76,7 +83,6 @@
 ----------------
 
 - project grouping
-- User groups/teams
 - code review (probably based on hg-review)
 - full git_ support, with push/pull server (currently in beta tests)
 - redmine integration