Mercurial > kallithea
annotate README.rst @ 1107:7bb902022d86 beta
small simplification in changelog
author | Marcin Kuzminski <marcin@python-works.com> |
---|---|
date | Tue, 01 Mar 2011 10:10:28 +0100 |
parents | 615c1bc11889 |
children | 9472a0150bf0 |
rev | line source |
---|---|
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
1 |
796 | 2 ================================================= |
3 Welcome to RhodeCode (RhodiumCode) documentation! | |
4 ================================================= | |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
5 |
1093 | 6 ``RhodeCode`` (formerly hg-app) is a Pylons framework based Mercurial repository |
7 browser/management tool with a built in push/pull server and full text search. | |
8 It works on http/https and has a built in permission/authentication system with | |
9 the ability to authenticate via LDAP. | |
10 | |
11 RhodeCode is similar in some respects to github or bitbucket, | |
12 however RhodeCode can be run as standalone hosted application on your own server. | |
13 It is open source and donation ware and focuses more on providing a customized, | |
14 self administered interface for Mercurial(and soon GIT) repositories. | |
15 RhodeCode is powered by a vcs_ library that Lukasz Balcerzak and I created to | |
16 handle multiple different version control systems. | |
572
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 uses `Semantic Versioning <http://semver.org/>`_ |
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 RhodeCode demo |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
21 -------------- |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
22 |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
23 http://hg.python-works.com |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
24 |
1093 | 25 The default access is anonymous but you can login to an administrative account |
26 using the following credentials: | |
254 | 27 |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
28 - username: demo |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
29 - password: demo |
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 Source code |
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 |
1093 | 34 The latest source for RhodeCode can be obtained from my own RhodeCode instance |
847 | 35 https://rhodecode.org |
254 | 36 |
847 | 37 Rarely updated source code and issue tracker is available at bitbcuket |
38 http://bitbucket.org/marcinkuzminski/rhodecode | |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
39 |
796 | 40 Installation |
41 ------------ | |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
42 |
1093 | 43 Please visit http://packages.python.org/RhodeCode/installation.html |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
44 |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
45 |
1093 | 46 RhodeCode Features |
47 ------------------ | |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
48 |
1093 | 49 - Has it's own middleware to handle mercurial_ protocol requests. |
50 Each request can be logged and authenticated. | |
51 - Runs on threads unlike 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
|
52 and LDAP |
847 | 53 - Full permissions (private/read/write/admin) and authentication per project. |
54 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
|
55 - Have built in users groups for easier permission management |
053983a464e4
docs and readme update
Marcin Kuzminski <marcin@python-works.com>
parents:
869
diff
changeset
|
56 - 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
|
57 combined changeset for all changeset made within single push. |
1093 | 58 - Mako templates let's you customize the look and feel of the application. |
59 - Beautiful diffs, annotations and source code browsing all colored by pygments. Raw | |
1062
053983a464e4
docs and readme update
Marcin Kuzminski <marcin@python-works.com>
parents:
869
diff
changeset
|
60 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
|
61 - Mercurial_ branch graph and yui-flot powered graphs with zooming and statistics |
847 | 62 - Admin interface with user/permission management. Admin activity journal, logs |
63 pulls, pushes, forks, registrations and other actions made by all users. | |
1093 | 64 - Server side forks. It is possible to fork a project and modify it freely without |
1062
053983a464e4
docs and readme update
Marcin Kuzminski <marcin@python-works.com>
parents:
869
diff
changeset
|
65 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
|
66 them |
1093 | 67 - Full text search powered by Whoosh on the source files, and file names. |
847 | 68 Build in indexing daemons, with optional incremental index build |
1093 | 69 (no external search servers required all in one application) |
847 | 70 - Setup project descriptions and info inside built in db for easy, non |
71 file-system operations | |
1093 | 72 - Intelligent cache with invalidation after push or project change, provides high |
73 performance and always up to date data. | |
847 | 74 - 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
|
75 - 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
|
76 - Backup scripts can do backup of whole app and send it over scp to desired |
847 | 77 location |
78 - Based on pylons / sqlalchemy / sqlite / whoosh / vcs | |
0 | 79 |
253
7effcce03192
docs update, developments serves statics as default
Marcin Kuzminski <marcin@python-works.com>
parents:
244
diff
changeset
|
80 |
796 | 81 .. include:: ./docs/screenshots.rst |
82 | |
83 | |
676
bdd1ddd05b7c
docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents:
643
diff
changeset
|
84 Incoming / Plans |
bdd1ddd05b7c
docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents:
643
diff
changeset
|
85 ---------------- |
241
48727add84c9
Made repos path config configurable from pylons app configs. update Readme
Marcin Kuzminski <marcin@python-works.com>
parents:
224
diff
changeset
|
86 |
1093 | 87 - Project grouping |
88 - SSH based authentication with server side key management | |
89 - Code review (probably based on hg-review) | |
90 - Full git_ support, with push/pull server (currently in beta tests) | |
91 - Redmine integration | |
92 - Public accessible activity feeds | |
93 - Commit based built in wiki system | |
94 - Clone points and cloning from remote repositories into RhodeCode | |
95 - More statistics and graph (global annotation + some more statistics) | |
96 - Other advancements as development continues (or you can of course make additions and or requests) | |
552
2642f128ad46
removed egg info, update files for distutils build
Marcin Kuzminski <marcin@python-works.com>
parents:
549
diff
changeset
|
97 |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
98 License |
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 |
1093 | 101 ``RhodeCode`` is released under the GPL_ license. |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
102 |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
103 |
676
bdd1ddd05b7c
docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents:
643
diff
changeset
|
104 Mailing group Q&A |
bdd1ddd05b7c
docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents:
643
diff
changeset
|
105 ----------------- |
bdd1ddd05b7c
docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents:
643
diff
changeset
|
106 |
1093 | 107 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
|
108 |
1093 | 109 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
|
110 |
1093 | 111 Join #rhodecode on FreeNode (irc.freenode.net) |
796 | 112 or use http://webchat.freenode.net/?channels=rhodecode for web access to irc. |
113 | |
114 Online documentation | |
115 -------------------- | |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
116 |
1093 | 117 Online documentation for the current version of RhodeCode is available at |
118 http://packages.python.org/RhodeCode/. | |
119 You may also build the documentation for yourself - go into ``docs/`` and run:: | |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
120 |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
121 make html |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
122 |
1093 | 123 (You need to have sphinx installed to build the documentation. If you don't |
124 have sphinx installed you can install it via the command: ``easy_install sphinx``) | |
125 | |
869
0a099e4ad4bf
fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents:
868
diff
changeset
|
126 .. _virtualenv: http://pypi.python.org/pypi/virtualenv |
0a099e4ad4bf
fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents:
868
diff
changeset
|
127 .. _python: http://www.python.org/ |
0a099e4ad4bf
fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents:
868
diff
changeset
|
128 .. _django: http://www.djangoproject.com/ |
0a099e4ad4bf
fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents:
868
diff
changeset
|
129 .. _mercurial: http://mercurial.selenic.com/ |
0a099e4ad4bf
fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents:
868
diff
changeset
|
130 .. _subversion: http://subversion.tigris.org/ |
0a099e4ad4bf
fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents:
868
diff
changeset
|
131 .. _git: http://git-scm.com/ |
0a099e4ad4bf
fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents:
868
diff
changeset
|
132 .. _celery: http://celeryproject.org/ |
0a099e4ad4bf
fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents:
868
diff
changeset
|
133 .. _Sphinx: http://sphinx.pocoo.org/ |
0a099e4ad4bf
fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents:
868
diff
changeset
|
134 .. _GPL: http://www.gnu.org/licenses/gpl.html |
0a099e4ad4bf
fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents:
868
diff
changeset
|
135 .. _vcs: http://pypi.python.org/pypi/vcs |