Mercurial > kallithea

annotate README.rst @ 1062:053983a464e4 beta

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
docs and readme update
author Marcin Kuzminski <marcin@python-works.com>
date Thu, 17 Feb 2011 00:44:45 +0100
parents 0a099e4ad4bf
children 615c1bc11889
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
1
796
47d5781bfe8a docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 727
diff changeset
2 =================================================
47d5781bfe8a docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 727
diff changeset
3 Welcome to RhodeCode (RhodiumCode) documentation!
47d5781bfe8a docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 727
diff changeset
4 =================================================
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
5
796
47d5781bfe8a docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 727
diff changeset
6 ``RhodeCode`` (formerly hg-app) is Pylons framework based Mercurial repository
1062
053983a464e4 docs and readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 869
diff changeset
7 browser/management tool with build in push/pull server and full text search.
053983a464e4 docs and readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 869
diff changeset
8 It works on http/https, has build in permission/authentication system with
053983a464e4 docs and readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 869
diff changeset
9 ability to auth via LDAP. It's similar in some parts to github or bitbucket,
053983a464e4 docs and readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 869
diff changeset
10 but it's suppose to run as standalone hosted application, it's open source
053983a464e4 docs and readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 869
diff changeset
11 and donation ware and focuses more on providing customized, self administered
053983a464e4 docs and readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 869
diff changeset
12 interface for Mercurial(and soon GIT) repositories. It's powered by vcs_
053983a464e4 docs and readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 869
diff changeset
13 library that me and Lukasz Balcerzak created to handle many various version
053983a464e4 docs and readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 869
diff changeset
14 control systems.
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
15
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
16 RhodeCode uses `Semantic Versioning <http://semver.org/>`_
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
17
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
18 RhodeCode demo
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
19 --------------
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
20
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
21 http://hg.python-works.com
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
22
847
75c425d0afeb updated readme
Marcin Kuzminski <marcin@python-works.com>
parents: 796
diff changeset
23 The default access is anonymous but You can login to administrative account
75c425d0afeb updated readme
Marcin Kuzminski <marcin@python-works.com>
parents: 796
diff changeset
24 using those credentials
254
85cbe7ad3402 doc fix
Marcin Kuzminski <marcin@python-works.com>
parents: 253
diff changeset
25
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
26 - username: demo
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
27 - password: demo
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
28
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
29 Source code
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
30 -----------
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
31
847
75c425d0afeb updated readme
Marcin Kuzminski <marcin@python-works.com>
parents: 796
diff changeset
32 The most up to date sources can be obtained from my own RhodeCode instance
75c425d0afeb updated readme
Marcin Kuzminski <marcin@python-works.com>
parents: 796
diff changeset
33 https://rhodecode.org
254
85cbe7ad3402 doc fix
Marcin Kuzminski <marcin@python-works.com>
parents: 253
diff changeset
34
847
75c425d0afeb updated readme
Marcin Kuzminski <marcin@python-works.com>
parents: 796
diff changeset
35 Rarely updated source code and issue tracker is available at bitbcuket
75c425d0afeb updated readme
Marcin Kuzminski <marcin@python-works.com>
parents: 796
diff changeset
36 http://bitbucket.org/marcinkuzminski/rhodecode
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
37
796
47d5781bfe8a docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 727
diff changeset
38 Installation
47d5781bfe8a docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 727
diff changeset
39 ------------
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
40
576
5c734b99c4db fixed backlinks and fixed target to docs
Marcin Kuzminski <marcin@python-works.com>
parents: 572
diff changeset
41 Please visit http://packages.python.org/RhodeCode/installation.html
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
42
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
43
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
44 Features
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
45 --------
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
46
847
75c425d0afeb updated readme
Marcin Kuzminski <marcin@python-works.com>
parents: 796
diff changeset
47 - Has it's own middleware to handle mercurial_ protocol request.
676
bdd1ddd05b7c docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents: 643
diff changeset
48 Each request can be logged and authenticated. Runs on threads unlikely to
847
75c425d0afeb updated readme
Marcin Kuzminski <marcin@python-works.com>
parents: 796
diff changeset
49 hgweb. You can make multiple pulls/pushes simultaneous. Supports http/https
1062
053983a464e4 docs and readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 869
diff changeset
50 and LDAP
847
75c425d0afeb updated readme
Marcin Kuzminski <marcin@python-works.com>
parents: 796
diff changeset
51 - Full permissions (private/read/write/admin) and authentication per project.
75c425d0afeb updated readme
Marcin Kuzminski <marcin@python-works.com>
parents: 796
diff changeset
52 One account for web interface and mercurial_ push/pull/clone operations.
1062
053983a464e4 docs and readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 869
diff changeset
53 - Have built in users groups for easier permission management
053983a464e4 docs and readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 869
diff changeset
54 - Users can fork other users repo. RhodeCode have also compare view to see
053983a464e4 docs and readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 869
diff changeset
55 combined changeset for all changeset made within single push.
564
ba7e24cd4786 refactor codes and setup for python 2.5
Marcin Kuzminski <marcin@python-works.com>
parents: 552
diff changeset
56 - Mako templates let's you customize look and feel of application.
1062
053983a464e4 docs and readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 869
diff changeset
57 - Beautiful diffs, annotations and source codes all colored by pygments. Raw
053983a464e4 docs and readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 869
diff changeset
58 diffs are made in git-diff format, including git binary-patches
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
59 - Mercurial_ branch graph and yui-flot powered graphs with zooming and statistics
847
75c425d0afeb updated readme
Marcin Kuzminski <marcin@python-works.com>
parents: 796
diff changeset
60 - Admin interface with user/permission management. Admin activity journal, logs
75c425d0afeb updated readme
Marcin Kuzminski <marcin@python-works.com>
parents: 796
diff changeset
61 pulls, pushes, forks, registrations and other actions made by all users.
564
ba7e24cd4786 refactor codes and setup for python 2.5
Marcin Kuzminski <marcin@python-works.com>
parents: 552
diff changeset
62 - Server side forks, it's possible to fork a project and hack it free without
1062
053983a464e4 docs and readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 869
diff changeset
63 breaking the main repository. You can even write Your own hooks and install
053983a464e4 docs and readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 869
diff changeset
64 them
847
75c425d0afeb updated readme
Marcin Kuzminski <marcin@python-works.com>
parents: 796
diff changeset
65 - Full text search powered by Whoosh on source codes, and file names.
75c425d0afeb updated readme
Marcin Kuzminski <marcin@python-works.com>
parents: 796
diff changeset
66 Build in indexing daemons, with optional incremental index build
1062
053983a464e4 docs and readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 869
diff changeset
67 (no external search servers required. All in one application !)
847
75c425d0afeb updated readme
Marcin Kuzminski <marcin@python-works.com>
parents: 796
diff changeset
68 - Setup project descriptions and info inside built in db for easy, non
75c425d0afeb updated readme
Marcin Kuzminski <marcin@python-works.com>
parents: 796
diff changeset
69 file-system operations
1062
053983a464e4 docs and readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 869
diff changeset
70 - Intelligent cache with invalidation after push or project change, provides
053983a464e4 docs and readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 869
diff changeset
71 high performance and always up to date data.
847
75c425d0afeb updated readme
Marcin Kuzminski <marcin@python-works.com>
parents: 796
diff changeset
72 - Rss / atom feeds, gravatar support, download sources as zip/tar/gz
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
73 - Async tasks for speed and performance using celery_ (works without them too)
564
ba7e24cd4786 refactor codes and setup for python 2.5
Marcin Kuzminski <marcin@python-works.com>
parents: 552
diff changeset
74 - Backup scripts can do backup of whole app and send it over scp to desired
847
75c425d0afeb updated readme
Marcin Kuzminski <marcin@python-works.com>
parents: 796
diff changeset
75 location
75c425d0afeb updated readme
Marcin Kuzminski <marcin@python-works.com>
parents: 796
diff changeset
76 - Based on pylons / sqlalchemy / sqlite / whoosh / vcs
0
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
77
253
7effcce03192 docs update, developments serves statics as default
Marcin Kuzminski <marcin@python-works.com>
parents: 244
diff changeset
78
796
47d5781bfe8a docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 727
diff changeset
79 .. include:: ./docs/screenshots.rst
47d5781bfe8a docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 727
diff changeset
80
47d5781bfe8a docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 727
diff changeset
81
676
bdd1ddd05b7c docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents: 643
diff changeset
82 Incoming / Plans
bdd1ddd05b7c docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents: 643
diff changeset
83 ----------------
241
48727add84c9 Made repos path config configurable from pylons app configs. update Readme
Marcin Kuzminski <marcin@python-works.com>
parents: 224
diff changeset
84
847
75c425d0afeb updated readme
Marcin Kuzminski <marcin@python-works.com>
parents: 796
diff changeset
85 - project grouping
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
86 - code review (probably based on hg-review)
796
47d5781bfe8a docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 727
diff changeset
87 - full git_ support, with push/pull server (currently in beta tests)
727
0ab5deeedbdf readme update and fixed whoosh version 1.3.3 has error
Marcin Kuzminski <marcin@python-works.com>
parents: 676
diff changeset
88 - redmine integration
847
75c425d0afeb updated readme
Marcin Kuzminski <marcin@python-works.com>
parents: 796
diff changeset
89 - public accessible activity feeds
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
90 - commit based build in wiki system
624
60a4aabf6aa6 small docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 576
diff changeset
91 - clone points and cloning from remote repositories into rhodecode
60a4aabf6aa6 small docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 576
diff changeset
92 (git_ and mercurial_)
676
bdd1ddd05b7c docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents: 643
diff changeset
93 - more statistics and graph (global annotation + some more statistics)
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
94 - other cools stuff that i can figure out (or You can help me figure out)
552
2642f128ad46 removed egg info, update files for distutils build
Marcin Kuzminski <marcin@python-works.com>
parents: 549
diff changeset
95
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
96 License
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
97 -------
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
98
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
99 ``rhodecode`` is released under GPL_ license.
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
100
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
101
676
bdd1ddd05b7c docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents: 643
diff changeset
102 Mailing group Q&A
bdd1ddd05b7c docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents: 643
diff changeset
103 -----------------
bdd1ddd05b7c docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents: 643
diff changeset
104
796
47d5781bfe8a docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 727
diff changeset
105 join the `Google group <http://groups.google.com/group/rhodecode>`_
676
bdd1ddd05b7c docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents: 643
diff changeset
106
796
47d5781bfe8a docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 727
diff changeset
107 open an issue at `issue tracker <http://bitbucket.org/marcinkuzminski/rhodecode/issues>`_
676
bdd1ddd05b7c docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents: 643
diff changeset
108
796
47d5781bfe8a docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 727
diff changeset
109 join #rhodecode on FreeNode (irc.freenode.net)
47d5781bfe8a docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 727
diff changeset
110 or use http://webchat.freenode.net/?channels=rhodecode for web access to irc.
47d5781bfe8a docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 727
diff changeset
111
47d5781bfe8a docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 727
diff changeset
112 Online documentation
47d5781bfe8a docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 727
diff changeset
113 --------------------
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
114
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
115 Online documentation for current version is available at
576
5c734b99c4db fixed backlinks and fixed target to docs
Marcin Kuzminski <marcin@python-works.com>
parents: 572
diff changeset
116 http://packages.python.org/RhodeCode/.
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
117 You may also build documentation for yourself - go into ``docs/`` and run::
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
118
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
119 make html
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
120
869
0a099e4ad4bf fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents: 868
diff changeset
121 .. _virtualenv: http://pypi.python.org/pypi/virtualenv
0a099e4ad4bf fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents: 868
diff changeset
122 .. _python: http://www.python.org/
0a099e4ad4bf fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents: 868
diff changeset
123 .. _django: http://www.djangoproject.com/
0a099e4ad4bf fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents: 868
diff changeset
124 .. _mercurial: http://mercurial.selenic.com/
0a099e4ad4bf fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents: 868
diff changeset
125 .. _subversion: http://subversion.tigris.org/
0a099e4ad4bf fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents: 868
diff changeset
126 .. _git: http://git-scm.com/
0a099e4ad4bf fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents: 868
diff changeset
127 .. _celery: http://celeryproject.org/
0a099e4ad4bf fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents: 868
diff changeset
128 .. _Sphinx: http://sphinx.pocoo.org/
0a099e4ad4bf fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents: 868
diff changeset
129 .. _GPL: http://www.gnu.org/licenses/gpl.html
0a099e4ad4bf fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents: 868
diff changeset
130 .. _vcs: http://pypi.python.org/pypi/vcs