Mercurial > kallithea

comparison README.rst @ 2020:bedd7336908c beta

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
docs updates
author Marcin Kuzminski <marcin@python-works.com>
date Wed, 22 Feb 2012 21:20:29 +0200
parents 87f0800abc7b
children 82a88013a3fd 3816bf3d0a5b
comparison
equal deleted inserted replaced
2019:3a014a84a2db 2020:bedd7336908c
1 ======================== 1 =========
2 RhodeCode documentation! 2 RhodeCode
3 ======================== 3 =========
4
5 About
6 -----
4 7
5 ``RhodeCode`` is a fast and powerful management tool for Mercurial_ and GIT_ 8 ``RhodeCode`` is a fast and powerful management tool for Mercurial_ and GIT_
6 with a built in push/pull server and full text search and code-review. 9 with a built in push/pull server and full text search and code-review.
7 It works on http/https and has a built in permission/authentication system with 10 It works on http/https and has a built in permission/authentication system with
8 the ability to authenticate via LDAP or ActiveDirectory. RhodeCode also provides 11 the ability to authenticate via LDAP or ActiveDirectory. RhodeCode also provides
14 self administered interface for Mercurial and GIT repositories. 17 self administered interface for Mercurial and GIT repositories.
15 RhodeCode is powered by a vcs_ library that Lukasz Balcerzak and I created to 18 RhodeCode is powered by a vcs_ library that Lukasz Balcerzak and I created to
16 handle multiple different version control systems. 19 handle multiple different version control systems.
17 20
18 RhodeCode uses `Semantic Versioning <http://semver.org/>`_ 21 RhodeCode uses `Semantic Versioning <http://semver.org/>`_
22
23 Installation
24 ------------
25 Stable releases of RhodeCode are best installed via::
26
27 easy_install rhodecode
28
29 Or::
30
31 pip install rhodecode
32
33 Detailed instructions and links may be found on the Installation page.
34
35 Please visit http://packages.python.org/RhodeCode/installation.html for
36 more details
19 37
20 RhodeCode demo 38 RhodeCode demo
21 -------------- 39 --------------
22 40
23 http://demo.rhodecode.org 41 http://demo.rhodecode.org
42 http://bitbucket.org/marcinkuzminski/rhodecode 60 http://bitbucket.org/marcinkuzminski/rhodecode
43 61
44 Sources at github_ 62 Sources at github_
45 63
46 https://github.com/marcinkuzminski/rhodecode 64 https://github.com/marcinkuzminski/rhodecode
47
48 Installation
49 ------------
50
51 Please visit http://packages.python.org/RhodeCode/installation.html
52 65
53 66
54 RhodeCode Features 67 RhodeCode Features
55 ------------------ 68 ------------------
56 69
89 - Async tasks for speed and performance using celery_ (works without them too) 102 - Async tasks for speed and performance using celery_ (works without them too)
90 - Backup scripts can do backup of whole app and send it over scp to desired 103 - Backup scripts can do backup of whole app and send it over scp to desired
91 location 104 location
92 - Based on pylons / sqlalchemy / sqlite / whoosh / vcs 105 - Based on pylons / sqlalchemy / sqlite / whoosh / vcs
93 106
94
95 .. include:: ./docs/screenshots.rst
96
97 107
98 Incoming / Plans 108 Incoming / Plans
99 ---------------- 109 ----------------
100 110
101 - Finer granular permissions per branch, repo group or subrepo 111 - Finer granular permissions per branch, repo group or subrepo
111 ------- 121 -------
112 122
113 ``RhodeCode`` is released under the GPLv3 license. 123 ``RhodeCode`` is released under the GPLv3 license.
114 124
115 125
116 Mailing group Q&A 126 Getting help
117 ----------------- 127 ------------
118 128
119 Join the `Google group <http://groups.google.com/group/rhodecode>`_ 129 Listed bellow are various support resources that should help.
120 130
121 Open an issue at `issue tracker <http://bitbucket.org/marcinkuzminski/rhodecode/issues>`_ 131 .. note::
132
133 Please try to read the documentation before posting any issues
134
135 - Join the `Google group <http://groups.google.com/group/rhodecode>`_ and ask
136 any questions.
122 137
123 Join #rhodecode on FreeNode (irc.freenode.net) 138 - Open an issue at `issue tracker <http://bitbucket.org/marcinkuzminski/rhodecode/issues>`_
124 or use http://webchat.freenode.net/?channels=rhodecode for web access to irc. 139
140
141 - Join #rhodecode on FreeNode (irc.freenode.net)
142 or use http://webchat.freenode.net/?channels=rhodecode for web access to irc.
143
144 - You can also follow me on twitter @marcinkuzminski where i often post some
145 news about RhodeCode
146
125 147
126 Online documentation 148 Online documentation
127 -------------------- 149 --------------------
128 150
129 Online documentation for the current version of RhodeCode is available at 151 Online documentation for the current version of RhodeCode is available at
130 http://packages.python.org/RhodeCode/. 152 - http://packages.python.org/RhodeCode/
153 - http://rhodecode.readthedocs.org/en/latest/index.html
154
131 You may also build the documentation for yourself - go into ``docs/`` and run:: 155 You may also build the documentation for yourself - go into ``docs/`` and run::
132 156
133 make html 157 make html
134 158
135 (You need to have sphinx_ installed to build the documentation. If you don't 159 (You need to have sphinx_ installed to build the documentation. If you don't