Mercurial > kallithea
annotate README.rst @ 868:cc635016933f beta
fixed error in setup.py RST generation, speling fix for README
author | Marcin Kuzminski <marcin@python-works.com> |
---|---|
date | Sat, 18 Dec 2010 18:10:45 +0100 |
parents | 86cbf8e6d76a |
children | 0a099e4ad4bf |
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 |
796 | 6 ``RhodeCode`` (formerly hg-app) is Pylons framework based Mercurial repository |
7 browser/management with build in push/pull server and full text search. | |
8 It works on http/https, has build in permission/authentication(+ldap) features | |
847 | 9 It's similar to github or bitbucket, but it's suppose to run as standalone |
10 hosted application, it's open source and focuses more on restricted access to | |
856
86cbf8e6d76a
fixed readme typo, added layout.html to sphinx theme
Marcin Kuzminski <marcin@python-works.com>
parents:
847
diff
changeset
|
11 repositories. It's powered by vcs_ library that me and Lukasz Balcerzak created |
847 | 12 to handle many various version control systems. |
572
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 uses `Semantic Versioning <http://semver.org/>`_ |
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 demo |
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 |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
19 http://hg.python-works.com |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
20 |
847 | 21 The default access is anonymous but You can login to administrative account |
22 using those credentials | |
254 | 23 |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
24 - username: demo |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
25 - password: demo |
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 |
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 |
847 | 30 The most up to date sources can be obtained from my own RhodeCode instance |
31 https://rhodecode.org | |
254 | 32 |
847 | 33 Rarely updated source code and issue tracker is available at bitbcuket |
34 http://bitbucket.org/marcinkuzminski/rhodecode | |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
35 |
796 | 36 Installation |
37 ------------ | |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
38 |
576
5c734b99c4db
fixed backlinks and fixed target to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
572
diff
changeset
|
39 Please visit http://packages.python.org/RhodeCode/installation.html |
572
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 |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
42 Features |
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 |
847 | 45 - 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
|
46 Each request can be logged and authenticated. Runs on threads unlikely to |
847 | 47 hgweb. You can make multiple pulls/pushes simultaneous. Supports http/https |
48 and ldap | |
49 - Full permissions (private/read/write/admin) and authentication per project. | |
50 One account for web interface and mercurial_ push/pull/clone operations. | |
564
ba7e24cd4786
refactor codes and setup for python 2.5
Marcin Kuzminski <marcin@python-works.com>
parents:
552
diff
changeset
|
51 - 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
|
52 - 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
|
53 - Mercurial_ branch graph and yui-flot powered graphs with zooming and statistics |
847 | 54 - Admin interface with user/permission management. Admin activity journal, logs |
55 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
|
56 - Server side forks, it's possible to fork a project and hack it free without |
847 | 57 breaking the main repository. |
58 - Full text search powered by Whoosh on source codes, and file names. | |
59 Build in indexing daemons, with optional incremental index build | |
498
6aa7db1c083a
version bump, small readme update
Marcin Kuzminski <marcin@python-works.com>
parents:
402
diff
changeset
|
60 (no external search servers required all in one application) |
847 | 61 - Setup project descriptions and info inside built in db for easy, non |
62 file-system operations | |
868
cc635016933f
fixed error in setup.py RST generation, speling fix for README
Marcin Kuzminski <marcin@python-works.com>
parents:
856
diff
changeset
|
63 - Intelligent cache with invalidation after push or project change, provides high |
847 | 64 performance and always up to date data. |
65 - 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
|
66 - 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
|
67 - Backup scripts can do backup of whole app and send it over scp to desired |
847 | 68 location |
69 - Based on pylons / sqlalchemy / sqlite / whoosh / vcs | |
0 | 70 |
253
7effcce03192
docs update, developments serves statics as default
Marcin Kuzminski <marcin@python-works.com>
parents:
244
diff
changeset
|
71 |
796 | 72 .. include:: ./docs/screenshots.rst |
73 | |
74 | |
676
bdd1ddd05b7c
docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents:
643
diff
changeset
|
75 Incoming / Plans |
bdd1ddd05b7c
docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents:
643
diff
changeset
|
76 ---------------- |
241
48727add84c9
Made repos path config configurable from pylons app configs. update Readme
Marcin Kuzminski <marcin@python-works.com>
parents:
224
diff
changeset
|
77 |
847 | 78 - project grouping |
79 - User groups/teams | |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
80 - code review (probably based on hg-review) |
796 | 81 - 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
|
82 - redmine integration |
847 | 83 - public accessible activity feeds |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
84 - commit based build in wiki system |
624
60a4aabf6aa6
small docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
576
diff
changeset
|
85 - clone points and cloning from remote repositories into rhodecode |
60a4aabf6aa6
small docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
576
diff
changeset
|
86 (git_ and mercurial_) |
676
bdd1ddd05b7c
docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents:
643
diff
changeset
|
87 - more statistics and graph (global annotation + some more statistics) |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
88 - 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
|
89 |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
90 License |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
91 ------- |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
92 |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
93 ``rhodecode`` is released under GPL_ license. |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
94 |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
95 |
676
bdd1ddd05b7c
docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents:
643
diff
changeset
|
96 Mailing group Q&A |
bdd1ddd05b7c
docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents:
643
diff
changeset
|
97 ----------------- |
bdd1ddd05b7c
docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents:
643
diff
changeset
|
98 |
796 | 99 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
|
100 |
796 | 101 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
|
102 |
796 | 103 join #rhodecode on FreeNode (irc.freenode.net) |
104 or use http://webchat.freenode.net/?channels=rhodecode for web access to irc. | |
105 | |
106 Online documentation | |
107 -------------------- | |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
108 |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
109 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
|
110 http://packages.python.org/RhodeCode/. |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
111 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
|
112 |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
113 make html |
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
114 |