##// END OF EJS Templates
fixed readme typo, added layout.html to sphinx theme
marcink -
r856:86cbf8e6 beta
parent child Browse files
Show More
@@ -0,0 +1,14 b''
1 {% extends "basic/layout.html" %}
2
3 {% block sidebarlogo %}
4 <h3>Support my development effort.</h3>
5 <div style="text-align:center">
6 <form action="https://www.paypal.com/cgi-bin/webscr" method="post">
7 <input type="hidden" name="cmd" value="_s-xclick">
8 <input type="hidden" name="hosted_button_id" value="8U2LLRPLBKWDU">
9 <input style="border:0px !important" type="image" src="https://www.paypal.com/en_US/i/btn/btn_donate_SM.gif"
10 border="0" name="submit" alt="PayPal - The safer, easier way to pay online!">
11 <img alt="" border="0" src="https://www.paypal.com/en_US/i/scr/pixel.gif" width="1" height="1">
12 </form>
13 </div>
14 {% endblock %}}
@@ -1,114 +1,114 b''
1 1
2 2 =================================================
3 3 Welcome to RhodeCode (RhodiumCode) documentation!
4 4 =================================================
5 5
6 6 ``RhodeCode`` (formerly hg-app) is Pylons framework based Mercurial repository
7 7 browser/management with build in push/pull server and full text search.
8 8 It works on http/https, has build in permission/authentication(+ldap) features
9 9 It's similar to github or bitbucket, but it's suppose to run as standalone
10 10 hosted application, it's open source and focuses more on restricted access to
11 repositories. It's powered by vcs_ library that me na Lukasz Balcerzak created
11 repositories. It's powered by vcs_ library that me and Lukasz Balcerzak created
12 12 to handle many various version control systems.
13 13
14 14 RhodeCode uses `Semantic Versioning <http://semver.org/>`_
15 15
16 16 RhodeCode demo
17 17 --------------
18 18
19 19 http://hg.python-works.com
20 20
21 21 The default access is anonymous but You can login to administrative account
22 22 using those credentials
23 23
24 24 - username: demo
25 25 - password: demo
26 26
27 27 Source code
28 28 -----------
29 29
30 30 The most up to date sources can be obtained from my own RhodeCode instance
31 31 https://rhodecode.org
32 32
33 33 Rarely updated source code and issue tracker is available at bitbcuket
34 34 http://bitbucket.org/marcinkuzminski/rhodecode
35 35
36 36 Installation
37 37 ------------
38 38
39 39 Please visit http://packages.python.org/RhodeCode/installation.html
40 40
41 41
42 42 Features
43 43 --------
44 44
45 45 - Has it's own middleware to handle mercurial_ protocol request.
46 46 Each request can be logged and authenticated. Runs on threads unlikely to
47 47 hgweb. You can make multiple pulls/pushes simultaneous. Supports http/https
48 48 and ldap
49 49 - Full permissions (private/read/write/admin) and authentication per project.
50 50 One account for web interface and mercurial_ push/pull/clone operations.
51 51 - Mako templates let's you customize look and feel of application.
52 52 - Beautiful diffs, annotations and source codes all colored by pygments.
53 53 - Mercurial_ branch graph and yui-flot powered graphs with zooming and statistics
54 54 - Admin interface with user/permission management. Admin activity journal, logs
55 55 pulls, pushes, forks, registrations and other actions made by all users.
56 56 - Server side forks, it's possible to fork a project and hack it free without
57 57 breaking the main repository.
58 58 - Full text search powered by Whoosh on source codes, and file names.
59 59 Build in indexing daemons, with optional incremental index build
60 60 (no external search servers required all in one application)
61 61 - Setup project descriptions and info inside built in db for easy, non
62 62 file-system operations
63 63 - Inteligent cache with invalidation after push or project change, provides high
64 64 performance and always up to date data.
65 65 - Rss / atom feeds, gravatar support, download sources as zip/tar/gz
66 66 - Async tasks for speed and performance using celery_ (works without them too)
67 67 - Backup scripts can do backup of whole app and send it over scp to desired
68 68 location
69 69 - Based on pylons / sqlalchemy / sqlite / whoosh / vcs
70 70
71 71
72 72 .. include:: ./docs/screenshots.rst
73 73
74 74
75 75 Incoming / Plans
76 76 ----------------
77 77
78 78 - project grouping
79 79 - User groups/teams
80 80 - code review (probably based on hg-review)
81 81 - full git_ support, with push/pull server (currently in beta tests)
82 82 - redmine integration
83 83 - public accessible activity feeds
84 84 - commit based build in wiki system
85 85 - clone points and cloning from remote repositories into rhodecode
86 86 (git_ and mercurial_)
87 87 - more statistics and graph (global annotation + some more statistics)
88 88 - other cools stuff that i can figure out (or You can help me figure out)
89 89
90 90 License
91 91 -------
92 92
93 93 ``rhodecode`` is released under GPL_ license.
94 94
95 95
96 96 Mailing group Q&A
97 97 -----------------
98 98
99 99 join the `Google group <http://groups.google.com/group/rhodecode>`_
100 100
101 101 open an issue at `issue tracker <http://bitbucket.org/marcinkuzminski/rhodecode/issues>`_
102 102
103 103 join #rhodecode on FreeNode (irc.freenode.net)
104 104 or use http://webchat.freenode.net/?channels=rhodecode for web access to irc.
105 105
106 106 Online documentation
107 107 --------------------
108 108
109 109 Online documentation for current version is available at
110 110 http://packages.python.org/RhodeCode/.
111 111 You may also build documentation for yourself - go into ``docs/`` and run::
112 112
113 113 make html
114 114
General Comments 0
You need to be logged in to leave comments. Login now