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