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