Mercurial > kallithea

annotate README.rst @ 676:bdd1ddd05b7c beta

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
docs update, setup libs version bumps
author Marcin Kuzminski <marcin@python-works.com>
date Thu, 11 Nov 2010 01:49:57 +0100
parents 9dc1d92d82ed
children 0ab5deeedbdf
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
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
2 RhodeCode (RhodiumCode)
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
3 =======================
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
4
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
5 ``RhodeCode`` (formerly hg-app) is Pylons based repository management and
643
9dc1d92d82ed updated setup for all newest versions
Marcin Kuzminski <marcin@python-works.com>
parents: 624
diff changeset
6 serving for mercurial_ and git_. It's similar to github or bitbucket, but
9dc1d92d82ed updated setup for all newest versions
Marcin Kuzminski <marcin@python-works.com>
parents: 624
diff changeset
7 it's suppose to run as standalone app, it's open source and focuses more on
9dc1d92d82ed updated setup for all newest versions
Marcin Kuzminski <marcin@python-works.com>
parents: 624
diff changeset
8 restricted access to repositories. There's no default free access to RhodeCode
9dc1d92d82ed updated setup for all newest versions
Marcin Kuzminski <marcin@python-works.com>
parents: 624
diff changeset
9 You have to create an account in order to use the application. It's powered
9dc1d92d82ed updated setup for all newest versions
Marcin Kuzminski <marcin@python-works.com>
parents: 624
diff changeset
10 by vcs_ library that we created to handle many various version control systems.
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
11
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
12 RhodeCode uses `Semantic Versioning <http://semver.org/>`_
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
13
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
14 RhodeCode demo
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
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
17 http://hg.python-works.com
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
18
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
19 The default access is
254
85cbe7ad3402 doc fix
Marcin Kuzminski <marcin@python-works.com>
parents: 253
diff changeset
20
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
21 - username: demo
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
22 - password: demo
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
23
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
24 Source code
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
25 -----------
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
26
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
27 Source code is along with issue tracker is available at
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
28 http://bitbucket.org/marcinkuzminski/rhodecode
254
85cbe7ad3402 doc fix
Marcin Kuzminski <marcin@python-works.com>
parents: 253
diff changeset
29
676
bdd1ddd05b7c docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents: 643
diff changeset
30 Also a source codes can be obtained from demo RhodeCode instance
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
31 http://hg.python-works.com/rhodecode/summary
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
32
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
33 Instalation
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
34 -----------
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
35
576
5c734b99c4db fixed backlinks and fixed target to docs
Marcin Kuzminski <marcin@python-works.com>
parents: 572
diff changeset
36 Please visit http://packages.python.org/RhodeCode/installation.html
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
37
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
38
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
39 Features
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
40 --------
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
41
676
bdd1ddd05b7c docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents: 643
diff changeset
42 - Has it's own middleware to handle mercurial_ and git_ protocol request.
bdd1ddd05b7c docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents: 643
diff changeset
43 Each request can be logged and authenticated. Runs on threads unlikely to
bdd1ddd05b7c docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents: 643
diff changeset
44 hgweb You can make multiple pulls/pushes simultaneous. Supports http/https
bdd1ddd05b7c docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents: 643
diff changeset
45 both on git_ and mercurial_
564
ba7e24cd4786 refactor codes and setup for python 2.5
Marcin Kuzminski <marcin@python-works.com>
parents: 552
diff changeset
46 - Full permissions and authentication per project private/read/write/admin.
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
47 One account for web interface and mercurial_ push/pull/clone.
564
ba7e24cd4786 refactor codes and setup for python 2.5
Marcin Kuzminski <marcin@python-works.com>
parents: 552
diff changeset
48 - Mako templates let's you customize look and feel of application.
ba7e24cd4786 refactor codes and setup for python 2.5
Marcin Kuzminski <marcin@python-works.com>
parents: 552
diff changeset
49 - Beautiful diffs, annotations and source codes all colored by pygments.
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
50 - Mercurial_ branch graph and yui-flot powered graphs with zooming and statistics
564
ba7e24cd4786 refactor codes and setup for python 2.5
Marcin Kuzminski <marcin@python-works.com>
parents: 552
diff changeset
51 - Admin interface with user/permission management. User activity journal logs
ba7e24cd4786 refactor codes and setup for python 2.5
Marcin Kuzminski <marcin@python-works.com>
parents: 552
diff changeset
52 pulls, pushes, forks,registrations. Possible to disable built in hooks
ba7e24cd4786 refactor codes and setup for python 2.5
Marcin Kuzminski <marcin@python-works.com>
parents: 552
diff changeset
53 - Server side forks, it's possible to fork a project and hack it free without
549
f99075170eb4 more renames for rhode code !!
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
54 breaking the main.
564
ba7e24cd4786 refactor codes and setup for python 2.5
Marcin Kuzminski <marcin@python-works.com>
parents: 552
diff changeset
55 - Full text search on source codes, search on file names. All powered by whoosh
ba7e24cd4786 refactor codes and setup for python 2.5
Marcin Kuzminski <marcin@python-works.com>
parents: 552
diff changeset
56 and build in indexing daemons
498
6aa7db1c083a version bump, small readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 402
diff changeset
57 (no external search servers required all in one application)
564
ba7e24cd4786 refactor codes and setup for python 2.5
Marcin Kuzminski <marcin@python-works.com>
parents: 552
diff changeset
58 - Rss / atom feeds, gravatar support, download sources as zip/tarballs
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
59 - 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
60 - Backup scripts can do backup of whole app and send it over scp to desired
ba7e24cd4786 refactor codes and setup for python 2.5
Marcin Kuzminski <marcin@python-works.com>
parents: 552
diff changeset
61 location
ba7e24cd4786 refactor codes and setup for python 2.5
Marcin Kuzminski <marcin@python-works.com>
parents: 552
diff changeset
62 - Setup project descriptions and info inside built in db for easy, non
290
702c7e565c56 docs update, version bump
Marcin Kuzminski <marcin@python-works.com>
parents: 254
diff changeset
63 file-system operations
564
ba7e24cd4786 refactor codes and setup for python 2.5
Marcin Kuzminski <marcin@python-works.com>
parents: 552
diff changeset
64 - Added cache with invalidation on push/repo management for high performance and
540
efbab97c3aca fixed some spelling mistakes
Marcin Kuzminski <marcin@python-works.com>
parents: 523
diff changeset
65 always up to date data.
564
ba7e24cd4786 refactor codes and setup for python 2.5
Marcin Kuzminski <marcin@python-works.com>
parents: 552
diff changeset
66 - Based on pylons 1.0 / sqlalchemy 0.6 / sqlite
0
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
67
253
7effcce03192 docs update, developments serves statics as default
Marcin Kuzminski <marcin@python-works.com>
parents: 244
diff changeset
68
676
bdd1ddd05b7c docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents: 643
diff changeset
69 Incoming / Plans
bdd1ddd05b7c docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents: 643
diff changeset
70 ----------------
241
48727add84c9 Made repos path config configurable from pylons app configs. update Readme
Marcin Kuzminski <marcin@python-works.com>
parents: 224
diff changeset
71
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
72 - code review (probably based on hg-review)
624
60a4aabf6aa6 small docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 576
diff changeset
73 - full git_ support, with push/pull server
676
bdd1ddd05b7c docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents: 643
diff changeset
74 - project grouping
bdd1ddd05b7c docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents: 643
diff changeset
75 - anonymous access
bdd1ddd05b7c docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents: 643
diff changeset
76 -
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
77 - commit based build in wiki system
624
60a4aabf6aa6 small docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 576
diff changeset
78 - clone points and cloning from remote repositories into rhodecode
60a4aabf6aa6 small docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 576
diff changeset
79 (git_ and mercurial_)
676
bdd1ddd05b7c docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents: 643
diff changeset
80 - more statistics and graph (global annotation + some more statistics)
bdd1ddd05b7c docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents: 643
diff changeset
81 - user customized activity dashboards
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
82 - some cache optimizations
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
83 - 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
84
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
85 License
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
86 -------
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
87
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
88 ``rhodecode`` is released under GPL_ license.
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
89
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
90
676
bdd1ddd05b7c docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents: 643
diff changeset
91 Mailing group Q&A
bdd1ddd05b7c docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents: 643
diff changeset
92 -----------------
bdd1ddd05b7c docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents: 643
diff changeset
93
bdd1ddd05b7c docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents: 643
diff changeset
94 http://groups.google.com/group/rhodecode
bdd1ddd05b7c docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents: 643
diff changeset
95
bdd1ddd05b7c docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents: 643
diff changeset
96
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
97 Documentation
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
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
100 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
101 http://packages.python.org/RhodeCode/.
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
102 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
103
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
104 make html
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
105
576
5c734b99c4db fixed backlinks and fixed target to docs
Marcin Kuzminski <marcin@python-works.com>
parents: 572
diff changeset
106 .. _virtualenv: http://pypi.python.org/pypi/virtualenv
5c734b99c4db fixed backlinks and fixed target to docs
Marcin Kuzminski <marcin@python-works.com>
parents: 572
diff changeset
107 .. _python: http://www.python.org/
5c734b99c4db fixed backlinks and fixed target to docs
Marcin Kuzminski <marcin@python-works.com>
parents: 572
diff changeset
108 .. _django: http://www.djangoproject.com/
5c734b99c4db fixed backlinks and fixed target to docs
Marcin Kuzminski <marcin@python-works.com>
parents: 572
diff changeset
109 .. _mercurial: http://mercurial.selenic.com/
5c734b99c4db fixed backlinks and fixed target to docs
Marcin Kuzminski <marcin@python-works.com>
parents: 572
diff changeset
110 .. _subversion: http://subversion.tigris.org/
5c734b99c4db fixed backlinks and fixed target to docs
Marcin Kuzminski <marcin@python-works.com>
parents: 572
diff changeset
111 .. _git: http://git-scm.com/
5c734b99c4db fixed backlinks and fixed target to docs
Marcin Kuzminski <marcin@python-works.com>
parents: 572
diff changeset
112 .. _celery: http://celeryproject.org/
5c734b99c4db fixed backlinks and fixed target to docs
Marcin Kuzminski <marcin@python-works.com>
parents: 572
diff changeset
113 .. _Sphinx: http://sphinx.pocoo.org/
5c734b99c4db fixed backlinks and fixed target to docs
Marcin Kuzminski <marcin@python-works.com>
parents: 572
diff changeset
114 .. _GPL: http://www.gnu.org/licenses/gpl.html
676
bdd1ddd05b7c docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents: 643
diff changeset
115 .. _vcs: http://pypi.python.org/pypi/vcs