changeset 847:75c425d0afeb beta

updated readme
author Marcin Kuzminski <marcin@python-works.com>
date Mon, 13 Dec 2010 01:06:48 +0100
parents 121c17037d7a
children a555d8345105
files README.rst
diffstat 1 files changed, 30 insertions(+), 27 deletions(-) [+]
line wrap: on
line diff
--- a/README.rst	Mon Dec 13 00:31:09 2010 +0100
+++ b/README.rst	Mon Dec 13 01:06:48 2010 +0100
@@ -6,10 +6,10 @@
 ``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 we created to handle many 
-various version control systems.
+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 na Lukasz Balcerzak created 
+to handle many various version control systems.
 
 RhodeCode uses `Semantic Versioning <http://semver.org/>`_
 
@@ -18,7 +18,8 @@
 
 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
@@ -26,11 +27,11 @@
 Source code
 -----------
 
-Source code is along with issue tracker is available at
-http://bitbucket.org/marcinkuzminski/rhodecode
+The most up to date sources can be obtained from my own RhodeCode instance
+https://rhodecode.org 
 
-Also a source codes can be obtained from demo RhodeCode instance
-http://hg.python-works.com/rhodecode/summary
+Rarely updated source code and issue tracker is available at bitbcuket
+http://bitbucket.org/marcinkuzminski/rhodecode
 
 Installation
 ------------
@@ -41,31 +42,31 @@
 Features
 --------
 
-- Has it's own middleware to handle mercurial_ and git_ protocol request. 
+- 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
-  both on git_ and mercurial_
-- Full permissions and authentication per project private/read/write/admin. 
-  One account for web interface and mercurial_ push/pull/clone.
+  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
 
 
 .. include:: ./docs/screenshots.rst
@@ -74,10 +75,12 @@
 Incoming / Plans
 ----------------
 
+- project grouping
+- User groups/teams
 - code review (probably based on hg-review)
 - full git_ support, with push/pull server (currently in beta tests)
-- project grouping
 - redmine integration
+- public accessible activity feeds
 - commit based build in wiki system
 - clone points and cloning from remote repositories into rhodecode 
   (git_ and mercurial_)