diff README.rst @ 564:ba7e24cd4786

refactor codes and setup for python 2.5 readme update
author Marcin Kuzminski <marcin@python-works.com>
date Sat, 09 Oct 2010 16:05:14 +0200
parents 2642f128ad46
children a60cd29ba7e2
line wrap: on
line diff
--- a/README.rst	Sat Oct 09 01:38:10 2010 +0200
+++ b/README.rst	Sat Oct 09 16:05:14 2010 +0200
@@ -1,33 +1,33 @@
---------------------------------------------------------------
-Pylons based repository management for mercurial (and soon git)
---------------------------------------------------------------
-
-Fully customizable, with authentication, permissions. Based on vcs library.
+------------------------------------------------
+Pylons based repository management for mercurial
+------------------------------------------------
 
 **Overview**
 
-- has it's own middleware to handle mercurial protocol request each request can 
-  be logged and authenticated + threaded performance unlikely to hgweb
-- full permissions per project read/write/admin access even on mercurial request
-- mako templates let's you customize look and feel of application.
-- diffs annotations and source code all colored by pygments.
-- mercurial branch graph and yui-flot powered graphs with zooming and statistics
-- admin interface for performing user/permission managements as well as repository
-  management.
-- server side forks, it's possible to fork a project and hack it free without
+- 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
+- Full permissions and authentication per project private/read/write/admin. 
+  One account for web interface and mercurial push/pull/clone.
+- 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
+- Server side forks, it's possible to fork a project and hack it free without
   breaking the main.   
-- full text search of source codes with indexing daemons using whoosh
+- Full text search on source codes, search on file names. All powered by whoosh
+  and build in indexing daemons
   (no external search servers required all in one application)
-- async tasks for speed and performance using celery (works without them too)  
-- Additional settings for mercurial web, (hooks editable from admin
-  panel !) also manage paths, archive, remote messages  
-- 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 
+- Rss / atom feeds, gravatar support, download sources as zip/tarballs  
+- 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
+- Added cache with invalidation on push/repo management for high performance and
   always up to date data. 
-- rss / atom feeds, gravatar support
-- based on pylons 1.0 / sqlalchemy 0.6
+- Based on pylons 1.0 / sqlalchemy 0.6 / sqlite
 
 **Incoming**
 
@@ -36,19 +36,14 @@
 - commit based wikis
 - clonning from remote repositories into rhodecode (git/mercurial)
 - other cools stuff that i can figure out (or You can help me figure out)
-
-.. note::
-   This software is still in beta mode. 
-   I don't guarantee that it'll work correctly.
    
+------------
+Installation
+------------
 
--------------
-Installation
--------------
-
-quick setup
+**quick setup**
  
-- pip install -E rhodecode-venv http://bitbucket.org/marcinkuzminski/rhodecode/get/tip.zip
+- pip install -E rhodecode-venv rhodecode
 - activate virtualenv
 - run `paster make-config RhodeCode production.ini`
 - run `paster setup-app production.ini`
@@ -56,8 +51,7 @@
 
 You're ready to go.
 
-
-MORE DETAILED INSTRUCTIONS
+**MORE DETAILED INSTRUCTIONS**
 
 - I highly recommend to install new virtualenv for rhodecode see 
   http://pypi.python.org/pypi/virtualenv for more details.
@@ -66,7 +60,7 @@
   Activate the virtualenv by running 
   `source activate /var/www/rhodecode-venv/bin/activate`   
 - Make a folder for rhodecode somewhere on the filesystem for example /var/www/rhodecode  
-- Run easy_install http://bitbucket.org/marcinkuzminski/rhodecode/get/tip.zip.
+- Run easy_install rhodecode
 - Run `paster make-config RhodeCode production.inii` in order to install 
   the application config. You can play with the app settings later 
 - Run `paster setup-app production.ini` it should create all needed tables 
@@ -83,12 +77,11 @@
   The app should gain a lot of speed and become much more responsible. 
   For installation instructions You can visit: 
   http://ask.github.com/celery/getting-started/index.html. 
-- All needed configs are inside rhodecode ie. celeryconfig.py , production.ini
-  You can configure the email, ports, loggers, workers from there.
+- All needed configs are inside rhodecode sources ie. celeryconfig.py, 
+  development.ini, production.ini You can configure the email, ports, loggers, 
+  workers from there.
 - For full text search You can either put crontab entry for 
   `python /var/www/rhodecode/rhodecode/lib/indexers/daemon.py incremental <path_to_repos>`
   or run indexer from admin panel. This will scann the repos given in the 
   application setup or given path for daemon.py and each scann in incremental 
-  mode will scann only changed files, 
-  Hg Update hook must be activated to index the content it's enabled by default
-  after setup
\ No newline at end of file
+  mode will scann only changed files.
\ No newline at end of file