##// END OF EJS Templates
docs: updated readme
marcink -
r3276:7bbad8f3 default
parent child Browse files
Show More
@@ -1,114 +1,116 b''
1 1 =========
2 2 RhodeCode
3 3 =========
4 4
5 5 About
6 6 -----
7 7
8 8 ``RhodeCode`` is a fast and powerful management tool for Mercurial_ and GIT_
9 9 and Subversion_ with a built in push/pull server, full text search,
10 pull requests and powerful code-review system. It works on http/https and
10 pull requests and powerful code-review system. It works on http/https, SSH and
11 11 has a few unique features like:
12 12
13 - plugable architecture
14 - advanced permission system with IP restrictions
15 - rich set of authentication plugins including LDAP,
16 ActiveDirectory, Atlassian Crowd, Http-Headers, Pam, Token-Auth.
17 - live code-review chat
18 - full web based file editing
19 - unified multi vcs support
20 - snippets (gist) system
21 - integration with all 3rd party issue trackers
13 - plugable architecture from Pyramid web-framework.
14 - advanced permission system with IP restrictions, inheritation, and user-groups.
15 - rich set of authentication plugins including LDAP, ActiveDirectory, SAML 2.0,
16 Atlassian Crowd, Http-Headers, Pam, Token-Auth, OAuth.
17 - live code-review chat, and reviewer rules.
18 - full web based file editing.
19 - unified multi vcs support.
20 - snippets (gist) system.
21 - integration framework for Slack, CI systems, Webhooks.
22 - integration with all 3rd party issue trackers.
23
22 24
23 25 RhodeCode also provides rich API, and multiple event hooks so it's easy
24 26 integrable with existing external systems.
25 27
26 28 RhodeCode is similar in some respects to gitlab_, github_ or bitbucket_,
27 29 however RhodeCode can be run as standalone hosted application on your own server.
28 30 RhodeCode can be installed on \*nix or Windows systems.
29 31
30 32 RhodeCode uses `PEP386 versioning <http://www.python.org/dev/peps/pep-0386/>`_
31 33
32 34 Installation
33 35 ------------
34 36 Please visit https://docs.rhodecode.com/RhodeCode-Control/tasks/install-cli.html
35 37 for more details
36 38
37 39
38 40 Source code
39 41 -----------
40 42
41 43 The latest sources can be obtained from official RhodeCode instance
42 44 https://code.rhodecode.com
43 45
44 46
45 47 Contributions
46 48 -------------
47 49
48 50 RhodeCode is open-source; contributions are welcome!
49 51
50 52 Please see the contribution documentation inside of the docs folder, which is
51 53 also available at
52 54 https://docs.rhodecode.com/RhodeCode-Enterprise/contributing/contributing.html
53 55
54 56 For additional information about collaboration tools, our issue tracker,
55 57 licensing, and contribution credit, visit https://rhodecode.com/open-source
56 58
57 59
58 60 RhodeCode Features
59 61 ------------------
60 62
61 63 Check out all features of RhodeCode at https://rhodecode.com/features
62 64
63 65 License
64 66 -------
65 67
66 68 ``RhodeCode`` is dual-licensed with AGPLv3 and commercial license.
67 69 Please see LICENSE.txt file for details.
68 70
69 71
70 72 Getting help
71 73 ------------
72 74
73 75 Listed bellow are various support resources that should help.
74 76
75 77 .. note::
76 78
77 79 Please try to read the documentation before posting any issues, especially
78 80 the **troubleshooting section**
79 81
80 82 - Official issue tracker `RhodeCode Issue tracker <https://issues.rhodecode.com>`_
81 83
82 84 - Official Slack Community Channel `RhodeCode Slack <https://rhodecode.com/join>`_
83 85
84 86 - Search our community portal `Community portal <https://community.rhodecode.com>`_
85 87
86 88 - You can also follow RhodeCode on twitter **@RhodeCode** where we often post
87 89 news and other interesting stuff about RhodeCode.
88 90
89 91
90 92 Online documentation
91 93 --------------------
92 94
93 95 Online documentation for the current version of RhodeCode is available at
94 96 - http://rhodecode.com/docs
95 97
96 98 You may also build the documentation for yourself - go into ``docs/`` and run::
97 99
98 100 nix-build default.nix -o result && make clean html
99 101
100 102 (You need to have sphinx_ installed to build the documentation. If you don't
101 103 have sphinx_ installed you can install it via the command:
102 104 ``pip install sphinx``)
103 105
104 106 .. _virtualenv: http://pypi.python.org/pypi/virtualenv
105 107 .. _python: http://www.python.org/
106 108 .. _sphinx: http://sphinx.pocoo.org/
107 109 .. _mercurial: http://mercurial.selenic.com/
108 110 .. _bitbucket: http://bitbucket.org/
109 111 .. _github: http://github.com/
110 112 .. _gitlab: http://gitlab.com/
111 113 .. _subversion: http://subversion.tigris.org/
112 114 .. _git: http://git-scm.com/
113 115 .. _celery: http://celeryproject.org/
114 116 .. _vcs: http://pypi.python.org/pypi/vcs
General Comments 0
You need to be logged in to leave comments. Login now