Mercurial > kallithea
annotate README.rst @ 4103:80528e613f7c
updated README with latest info regarding rhodecode.com, installation etc
author | Marcin Kuzminski <marcin@python-works.com> |
---|---|
date | Sun, 01 Sep 2013 20:04:03 +0200 |
parents | 5293d4bbb1ea |
children |
rev | line source |
---|---|
2020 | 1 ========= |
2 RhodeCode | |
3 ========= | |
4 | |
5 About | |
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 | 12 simple API so it's easy integrable with existing external systems. |
1093 | 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 | 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 | 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 | 24 Installation |
25 ------------ | |
26 Stable releases of RhodeCode are best installed via:: | |
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 | 29 |
30 Detailed instructions and links may be found on the Installation page. | |
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 | 40 |
1167
312712050c7e
fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents:
1127
diff
changeset
|
41 |
1093 | 42 RhodeCode Features |
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 | 54 Getting help |
55 ------------ | |
676
bdd1ddd05b7c
docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents:
643
diff
changeset
|
56 |
2020 | 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 | 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 | 71 |
72 - Join #rhodecode on FreeNode (irc.freenode.net) | |
73 or use http://webchat.freenode.net/?channels=rhodecode for web access to irc. | |
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 | 77 |
796 | 78 |
79 Online documentation | |
80 -------------------- | |
572
a60cd29ba7e2
more docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
564
diff
changeset
|
81 |
1093 | 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 | 84 |
1093 | 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 | 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 |