Mercurial > kallithea

annotate README.rst @ 4106:4e429252f3ee

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Don't use -p flag together with -s in git calls. Latest git version changes behaviour of such call changing the output. In all the calls where -p -s was used we're only interested in list of changesets and not the diff.
author Marcin Kuzminski <marcin@python-works.com>
date Mon, 02 Sep 2013 16:57:30 +0200
parents 80528e613f7c
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2020
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
1 =========
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
2 RhodeCode
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
3 =========
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
4
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
5 About
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
6 -----
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
7
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3184
diff changeset
8 ``RhodeCode`` is a fast and powerful management tool for Mercurial_ and GIT_
3306
d09c037df514 Fixed README spelling
Marcin Kuzminski <marcin@python-works.com>
parents: 3224
diff changeset
9 with a built in push/pull server, full text search and code-review.
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3184
diff changeset
10 It works on http/https and has a built in permission/authentication system with
1982
87f0800abc7b #227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
11 the ability to authenticate via LDAP or ActiveDirectory. RhodeCode also provides
1750
cbcae0c83eb0 updated docs
Marcin Kuzminski <marcin@python-works.com>
parents: 1663
diff changeset
12 simple API so it's easy integrable with existing external systems.
1093
615c1bc11889 readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 1062
diff changeset
13
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3184
diff changeset
14 RhodeCode is similar in some respects to github_ or bitbucket_,
1750
cbcae0c83eb0 updated docs
Marcin Kuzminski <marcin@python-works.com>
parents: 1663
diff changeset
15 however RhodeCode can be run as standalone hosted application on your own server.
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3184
diff changeset
16 It is open source and donation ware and focuses more on providing a customized,
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3184
diff changeset
17 self administered interface for Mercurial_ and GIT_ repositories.
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3184
diff changeset
18 RhodeCode works on \*nix systems and Windows it is powered by a vcs_ library
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3184
diff changeset
19 that Lukasz Balcerzak and Marcin Kuzminski created to handle multiple
2117
d743568f2f57 readme update, write rhodecode works on windows !
Marcin Kuzminski <marcin@python-works.com>
parents: 2034
diff changeset
20 different version control systems.
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
21
2167
Marcin Kuzminski <marcin@python-works.com>
parents: 2146
diff changeset
22 RhodeCode uses `PEP386 versioning <http://www.python.org/dev/peps/pep-0386/>`_
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
23
2020
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
24 Installation
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
25 ------------
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
26 Stable releases of RhodeCode are best installed via::
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
27
4103
80528e613f7c updated README with latest info regarding rhodecode.com, installation etc
Marcin Kuzminski <marcin@python-works.com>
parents: 3960
diff changeset
28 pip install https://rhodecode.com/dl/latest
2020
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
29
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
30 Detailed instructions and links may be found on the Installation page.
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
31
4103
80528e613f7c updated README with latest info regarding rhodecode.com, installation etc
Marcin Kuzminski <marcin@python-works.com>
parents: 3960
diff changeset
32 Please visit https://rhodecode.com/docs/installation.html for more details
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
33
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 Source code
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
36 -----------
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
37
1167
312712050c7e fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 1127
diff changeset
38 The latest sources can be obtained from official RhodeCode instance
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3184
diff changeset
39 https://secure.rhodecode.org
254
85cbe7ad3402 doc fix
Marcin Kuzminski <marcin@python-works.com>
parents: 253
diff changeset
40
1167
312712050c7e fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 1127
diff changeset
41
1093
615c1bc11889 readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 1062
diff changeset
42 RhodeCode Features
615c1bc11889 readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 1062
diff changeset
43 ------------------
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
44
4103
80528e613f7c updated README with latest info regarding rhodecode.com, installation etc
Marcin Kuzminski <marcin@python-works.com>
parents: 3960
diff changeset
45 Check out all features of RhodeCode at https://rhodecode.com/features
552
2642f128ad46 removed egg info, update files for distutils build
Marcin Kuzminski <marcin@python-works.com>
parents: 549
diff changeset
46
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
47 License
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
48 -------
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
49
4103
80528e613f7c updated README with latest info regarding rhodecode.com, installation etc
Marcin Kuzminski <marcin@python-works.com>
parents: 3960
diff changeset
50 ``RhodeCode`` is released under the GPLv3 license. Please see
80528e613f7c updated README with latest info regarding rhodecode.com, installation etc
Marcin Kuzminski <marcin@python-works.com>
parents: 3960
diff changeset
51 LICENSE file for details
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
52
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
53
2020
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
54 Getting help
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
55 ------------
676
bdd1ddd05b7c docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents: 643
diff changeset
56
2020
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
57 Listed bellow are various support resources that should help.
676
bdd1ddd05b7c docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents: 643
diff changeset
58
2020
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
59 .. note::
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3184
diff changeset
60
2601
aa90719e8520 Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents: 2266
diff changeset
61 Please try to read the documentation before posting any issues, especially
aa90719e8520 Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents: 2266
diff changeset
62 the **troubleshooting section**
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3184
diff changeset
63
4103
80528e613f7c updated README with latest info regarding rhodecode.com, installation etc
Marcin Kuzminski <marcin@python-works.com>
parents: 3960
diff changeset
64 - Search the `Knowledge base <https://rhodecode.com/help/dashboard/kb>`_ for
80528e613f7c updated README with latest info regarding rhodecode.com, installation etc
Marcin Kuzminski <marcin@python-works.com>
parents: 3960
diff changeset
65 known issues or problems.
676
bdd1ddd05b7c docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents: 643
diff changeset
66
4103
80528e613f7c updated README with latest info regarding rhodecode.com, installation etc
Marcin Kuzminski <marcin@python-works.com>
parents: 3960
diff changeset
67 - Search the old `Discussion group <http://groups.google.com/group/rhodecode>`_ for
80528e613f7c updated README with latest info regarding rhodecode.com, installation etc
Marcin Kuzminski <marcin@python-works.com>
parents: 3960
diff changeset
68 known issues or problems. (Depracated)
80528e613f7c updated README with latest info regarding rhodecode.com, installation etc
Marcin Kuzminski <marcin@python-works.com>
parents: 3960
diff changeset
69
80528e613f7c updated README with latest info regarding rhodecode.com, installation etc
Marcin Kuzminski <marcin@python-works.com>
parents: 3960
diff changeset
70 - Open an issue at `support page <https://rhodecode.com/help>`_
2020
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
71
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
72 - Join #rhodecode on FreeNode (irc.freenode.net)
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
73 or use http://webchat.freenode.net/?channels=rhodecode for web access to irc.
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
74
4103
80528e613f7c updated README with latest info regarding rhodecode.com, installation etc
Marcin Kuzminski <marcin@python-works.com>
parents: 3960
diff changeset
75 - You can also follow RhodeCode on twitter **@RhodeCode** where we often post
80528e613f7c updated README with latest info regarding rhodecode.com, installation etc
Marcin Kuzminski <marcin@python-works.com>
parents: 3960
diff changeset
76 news and other interesting stuff about RhodeCode.
2020
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
77
796
47d5781bfe8a docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 727
diff changeset
78
47d5781bfe8a docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 727
diff changeset
79 Online documentation
47d5781bfe8a docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 727
diff changeset
80 --------------------
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
81
1093
615c1bc11889 readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 1062
diff changeset
82 Online documentation for the current version of RhodeCode is available at
4103
80528e613f7c updated README with latest info regarding rhodecode.com, installation etc
Marcin Kuzminski <marcin@python-works.com>
parents: 3960
diff changeset
83 - http://rhodecode.com/docs
2020
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
84
1093
615c1bc11889 readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 1062
diff changeset
85 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
86
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
87 make html
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
88
1167
312712050c7e fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 1127
diff changeset
89 (You need to have sphinx_ installed to build the documentation. If you don't
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3184
diff changeset
90 have sphinx_ installed you can install it via the command:
4103
80528e613f7c updated README with latest info regarding rhodecode.com, installation etc
Marcin Kuzminski <marcin@python-works.com>
parents: 3960
diff changeset
91 ``pip install sphinx``)
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3184
diff changeset
92
869
0a099e4ad4bf fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents: 868
diff changeset
93 .. _virtualenv: http://pypi.python.org/pypi/virtualenv
0a099e4ad4bf fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents: 868
diff changeset
94 .. _python: http://www.python.org/
1167
312712050c7e fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 1127
diff changeset
95 .. _sphinx: http://sphinx.pocoo.org/
869
0a099e4ad4bf fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents: 868
diff changeset
96 .. _mercurial: http://mercurial.selenic.com/
1123
9472a0150bf0 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 1093
diff changeset
97 .. _bitbucket: http://bitbucket.org/
1167
312712050c7e fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 1127
diff changeset
98 .. _github: http://github.com/
869
0a099e4ad4bf fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents: 868
diff changeset
99 .. _subversion: http://subversion.tigris.org/
0a099e4ad4bf fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents: 868
diff changeset
100 .. _git: http://git-scm.com/
0a099e4ad4bf fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents: 868
diff changeset
101 .. _celery: http://celeryproject.org/
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3184
diff changeset
102 .. _vcs: http://pypi.python.org/pypi/vcs