comparison README.rst @ 1071:bdc438fb4fe4

Fixes for release 1.1.4 Docs updates
author Marcin Kuzminski <marcin@python-works.com>
date Sat, 19 Feb 2011 14:00:01 +0100
parents 86cbf8e6d76a
children e67786cb2afa
comparison
equal deleted inserted replaced
1059:74015c16debd 1071:bdc438fb4fe4
2 ================================================= 2 =================================================
3 Welcome to RhodeCode (RhodiumCode) documentation! 3 Welcome to RhodeCode (RhodiumCode) documentation!
4 ================================================= 4 =================================================
5 5
6 ``RhodeCode`` (formerly hg-app) is Pylons framework based Mercurial repository 6 ``RhodeCode`` (formerly hg-app) is Pylons framework based Mercurial repository
7 browser/management with build in push/pull server and full text search. 7 browser/management tool with build in push/pull server and full text search.
8 It works on http/https, has build in permission/authentication(+ldap) features 8 It works on http/https, has build in permission/authentication system with
9 It's similar to github or bitbucket, but it's suppose to run as standalone 9 ability to auth via LDAP. It's similar in some parts to github or bitbucket,
10 hosted application, it's open source and focuses more on restricted access to 10 but it's suppose to run as standalone hosted application, it's open source
11 repositories. It's powered by vcs_ library that me and Lukasz Balcerzak created 11 and donation ware and focuses more on providing customized, self administered
12 to handle many various version control systems. 12 interface for Mercurial(and soon GIT) repositories. It's powered by vcs_
13 library that me and Lukasz Balcerzak created to handle many various version
14 control systems.
13 15
14 RhodeCode uses `Semantic Versioning <http://semver.org/>`_ 16 RhodeCode uses `Semantic Versioning <http://semver.org/>`_
15 17
16 RhodeCode demo 18 RhodeCode demo
17 -------------- 19 --------------
43 -------- 45 --------
44 46
45 - Has it's own middleware to handle mercurial_ protocol request. 47 - Has it's own middleware to handle mercurial_ protocol request.
46 Each request can be logged and authenticated. Runs on threads unlikely to 48 Each request can be logged and authenticated. Runs on threads unlikely to
47 hgweb. You can make multiple pulls/pushes simultaneous. Supports http/https 49 hgweb. You can make multiple pulls/pushes simultaneous. Supports http/https
48 and ldap 50 and LDAP
49 - Full permissions (private/read/write/admin) and authentication per project. 51 - Full permissions (private/read/write/admin) and authentication per project.
50 One account for web interface and mercurial_ push/pull/clone operations. 52 One account for web interface and mercurial_ push/pull/clone operations.
51 - Mako templates let's you customize look and feel of application. 53 - Mako templates let's you customize look and feel of application.
52 - Beautiful diffs, annotations and source codes all colored by pygments. 54 - Beautiful diffs, annotations and source codes all colored by pygments.
53 - Mercurial_ branch graph and yui-flot powered graphs with zooming and statistics 55 - Mercurial_ branch graph and yui-flot powered graphs with zooming and statistics
58 - Full text search powered by Whoosh on source codes, and file names. 60 - Full text search powered by Whoosh on source codes, and file names.
59 Build in indexing daemons, with optional incremental index build 61 Build in indexing daemons, with optional incremental index build
60 (no external search servers required all in one application) 62 (no external search servers required all in one application)
61 - Setup project descriptions and info inside built in db for easy, non 63 - Setup project descriptions and info inside built in db for easy, non
62 file-system operations 64 file-system operations
63 - Inteligent cache with invalidation after push or project change, provides high 65 - Intelligent cache with invalidation after push or project change, provides high
64 performance and always up to date data. 66 performance and always up to date data.
65 - Rss / atom feeds, gravatar support, download sources as zip/tar/gz 67 - Rss / atom feeds, gravatar support, download sources as zip/tar/gz
66 - Async tasks for speed and performance using celery_ (works without them too) 68 - Async tasks for speed and performance using celery_ (works without them too)
67 - Backup scripts can do backup of whole app and send it over scp to desired 69 - Backup scripts can do backup of whole app and send it over scp to desired
68 location 70 location
75 Incoming / Plans 77 Incoming / Plans
76 ---------------- 78 ----------------
77 79
78 - project grouping 80 - project grouping
79 - User groups/teams 81 - User groups/teams
82 - ssh based authentication with server side key management
80 - code review (probably based on hg-review) 83 - code review (probably based on hg-review)
81 - full git_ support, with push/pull server (currently in beta tests) 84 - full git_ support, with push/pull server (currently in beta tests)
82 - redmine integration 85 - redmine integration
83 - public accessible activity feeds 86 - public accessible activity feeds
84 - commit based build in wiki system 87 - commit based build in wiki system
85 - clone points and cloning from remote repositories into rhodecode 88 - clone points and cloning from remote repositories into RhodeCode
86 (git_ and mercurial_)
87 - more statistics and graph (global annotation + some more statistics) 89 - more statistics and graph (global annotation + some more statistics)
88 - other cools stuff that i can figure out (or You can help me figure out) 90 - other cools stuff that i can figure out (or You can help me figure out)
89 91
90 License 92 License
91 ------- 93 -------
92 94
93 ``rhodecode`` is released under GPL_ license. 95 ``RhodeCode`` is released under GPL_ license.
94 96
95 97
96 Mailing group Q&A 98 Mailing group Q&A
97 ----------------- 99 -----------------
98 100
110 http://packages.python.org/RhodeCode/. 112 http://packages.python.org/RhodeCode/.
111 You may also build documentation for yourself - go into ``docs/`` and run:: 113 You may also build documentation for yourself - go into ``docs/`` and run::
112 114
113 make html 115 make html
114 116
117 .. _virtualenv: http://pypi.python.org/pypi/virtualenv
118 .. _python: http://www.python.org/
119 .. _django: http://www.djangoproject.com/
120 .. _mercurial: http://mercurial.selenic.com/
121 .. _subversion: http://subversion.tigris.org/
122 .. _git: http://git-scm.com/
123 .. _celery: http://celeryproject.org/
124 .. _Sphinx: http://sphinx.pocoo.org/
125 .. _GPL: http://www.gnu.org/licenses/gpl.html
126 .. _vcs: http://pypi.python.org/pypi/vcs