diff docs/index.rst @ 622:a60cd29ba7e2

more docs update
author Marcin Kuzminski <marcin@python-works.com>
date Sun, 10 Oct 2010 21:34:24 +0200
parents 39d9aca6e266
children 42a87338035a
line wrap: on
line diff
--- a/docs/index.rst	Sun Oct 10 18:00:54 2010 +0200
+++ b/docs/index.rst	Sun Oct 10 21:34:24 2010 +0200
@@ -3,12 +3,18 @@
 Welcome to RhodeCode (RhodiumCode) documentation!
 =================================================
 
-``RhodeCode`` is Pylons based repository management and serving for mercurial. 
-It's similar to github or bitbucket, but focuses more on closed access restrictions.
+``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. 
+to use the application. It's powered by vcs_ library that we created to handle
+many various version control systems.
 
-**RhodeCode demo is available at**
+RhodeCode uses `Semantic Versioning <http://semver.org/>`_
+
+
+RhodeCode demo
+--------------
 
 http://hg.python-works.com
 
@@ -17,18 +23,26 @@
 - username: demo
 - password: demo
 
-RhodeCode uses `Semantic Versioning <http://semver.org/>`_
+Source code
+-----------
+
+Source code is along with issue tracker is available at
+http://bitbucket.org/marcinkuzminski/rhodecode
 
-**Features**
+Also a source codes can be obtained from demo rhodecode instance
+http://hg.python-works.com/rhodecode/summary
 
-- Has it's own middleware to handle mercurial protocol request. Each request can 
+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
 - Full permissions and authentication per project private/read/write/admin. 
-  One account for web interface and mercurial push/pull/clone.
+  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
+- 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
@@ -37,7 +51,7 @@
   and build in indexing daemons
   (no external search servers required all in one application)
 - Rss / atom feeds, gravatar support, download sources as zip/tarballs  
-- Async tasks for speed and performance using celery (works without them too)  
+- 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 
@@ -58,16 +72,24 @@
    Summary page
 
 
-**Incoming**
+Incoming
+--------
 
-- code review based on hg-review (when it's stable)
-- git support (when vcs can handle it - almost there !)
-- commit based wikis
-- clonning from remote repositories into rhodecode (git/mercurial)
+- code review (probably based on hg-review)
+- git_ support (when vcs_ can handle it - it's almost there !)
+- commit based build in wiki system
+- clone points and cloning from remote repositories into rhodecode (git_ and mercurial_)
+- some cache optimizations
 - other cools stuff that i can figure out (or You can help me figure out)
 
+License
+-------
+
+``rhodecode`` is released under GPL_ license.
+
+
 Documentation
-=============
+-------------
 
 **Installation:**
 
@@ -78,13 +100,18 @@
    setup
 
 Other topics
-============
+------------
 
 * :ref:`genindex`
 * :ref:`search`
 
+.. _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/
\ No newline at end of file
+.. _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