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