Mercurial > kallithea

annotate README.rst @ 3720:9855b31d033b beta

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
pullrequests: fix changesets ordering being reversed when creating new pull requests 41b4edf77b5b tried to make the displayed order of changeset consistent: The topmost is always the latest. That did however also reverse the ordering of the changesets sent back in the post when used in the pull request creation form. Displaying the pull request later on would reverse it again and thus show it in the 'wrong' order. We now undo that reversing when creating the pull requests, and the stored data will thus be the same as before.
author Mads Kiilerich <madski@unity3d.com>
date Thu, 04 Apr 2013 18:50:08 +0200
parents 5f1850e4712a
children 3563bb7b4b82 832907f41ee6
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2020
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
1 =========
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
2 RhodeCode
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
3 =========
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
4
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
5 About
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
6 -----
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
7
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3184
diff changeset
8 ``RhodeCode`` is a fast and powerful management tool for Mercurial_ and GIT_
3306
d09c037df514 Fixed README spelling
Marcin Kuzminski <marcin@python-works.com>
parents: 3224
diff changeset
9 with a built in push/pull server, full text search and code-review.
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3184
diff changeset
10 It works on http/https and has a built in permission/authentication system with
1982
87f0800abc7b #227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
11 the ability to authenticate via LDAP or ActiveDirectory. RhodeCode also provides
1750
cbcae0c83eb0 updated docs
Marcin Kuzminski <marcin@python-works.com>
parents: 1663
diff changeset
12 simple API so it's easy integrable with existing external systems.
1093
615c1bc11889 readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 1062
diff changeset
13
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3184
diff changeset
14 RhodeCode is similar in some respects to github_ or bitbucket_,
1750
cbcae0c83eb0 updated docs
Marcin Kuzminski <marcin@python-works.com>
parents: 1663
diff changeset
15 however RhodeCode can be run as standalone hosted application on your own server.
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3184
diff changeset
16 It is open source and donation ware and focuses more on providing a customized,
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3184
diff changeset
17 self administered interface for Mercurial_ and GIT_ repositories.
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3184
diff changeset
18 RhodeCode works on \*nix systems and Windows it is powered by a vcs_ library
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3184
diff changeset
19 that Lukasz Balcerzak and Marcin Kuzminski created to handle multiple
2117
d743568f2f57 readme update, write rhodecode works on windows !
Marcin Kuzminski <marcin@python-works.com>
parents: 2034
diff changeset
20 different version control systems.
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
21
2167
Marcin Kuzminski <marcin@python-works.com>
parents: 2146
diff changeset
22 RhodeCode uses `PEP386 versioning <http://www.python.org/dev/peps/pep-0386/>`_
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
23
2020
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
24 Installation
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
25 ------------
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
26 Stable releases of RhodeCode are best installed via::
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
27
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
28 easy_install rhodecode
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
29
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
30 Or::
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
31
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3184
diff changeset
32 pip install rhodecode
2020
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
33
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
34 Detailed instructions and links may be found on the Installation page.
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
35
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
36 Please visit http://packages.python.org/RhodeCode/installation.html for
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
37 more details
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
38
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
39 RhodeCode demo
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
40 --------------
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
41
1127
a31b0bf8c9a7 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 1123
diff changeset
42 http://demo.rhodecode.org
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
43
1093
615c1bc11889 readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 1062
diff changeset
44 The default access is anonymous but you can login to an administrative account
615c1bc11889 readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 1062
diff changeset
45 using the following credentials:
254
85cbe7ad3402 doc fix
Marcin Kuzminski <marcin@python-works.com>
parents: 253
diff changeset
46
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
47 - username: demo
1488
dc16211e7292 Updated docs and contributors
Marcin Kuzminski <marcin@python-works.com>
parents: 1405
diff changeset
48 - password: demo12
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
49
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
50 Source code
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
51 -----------
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
52
1167
312712050c7e fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 1127
diff changeset
53 The latest sources can be obtained from official RhodeCode instance
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3184
diff changeset
54 https://secure.rhodecode.org
254
85cbe7ad3402 doc fix
Marcin Kuzminski <marcin@python-works.com>
parents: 253
diff changeset
55
1167
312712050c7e fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 1127
diff changeset
56
312712050c7e fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 1127
diff changeset
57 MIRRORS:
312712050c7e fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 1127
diff changeset
58
312712050c7e fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 1127
diff changeset
59 Issue tracker and sources at bitbucket_
312712050c7e fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 1127
diff changeset
60
847
75c425d0afeb updated readme
Marcin Kuzminski <marcin@python-works.com>
parents: 796
diff changeset
61 http://bitbucket.org/marcinkuzminski/rhodecode
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
62
1167
312712050c7e fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 1127
diff changeset
63 Sources at github_
312712050c7e fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 1127
diff changeset
64
312712050c7e fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 1127
diff changeset
65 https://github.com/marcinkuzminski/rhodecode
312712050c7e fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 1127
diff changeset
66
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
67
1093
615c1bc11889 readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 1062
diff changeset
68 RhodeCode Features
615c1bc11889 readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 1062
diff changeset
69 ------------------
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
70
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3184
diff changeset
71 - Has its own middleware to handle mercurial_ and git_ protocol requests.
3184
6180e031a2b9 readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 2775
diff changeset
72 Each request is authenticated and logged together with IP address.
6180e031a2b9 readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 2775
diff changeset
73 - Build for speed and performance. You can make multiple pulls/pushes simultaneous.
6180e031a2b9 readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 2775
diff changeset
74 Proven to work with 1000s of repositories and users
6180e031a2b9 readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 2775
diff changeset
75 - Supports http/https, LDAP, AD, proxy-pass authentication.
6180e031a2b9 readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 2775
diff changeset
76 - Full permissions (private/read/write/admin) together with IP restrictions for each repository,
6180e031a2b9 readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 2775
diff changeset
77 additional explicit forking and repository creation permissions.
3410
5f1850e4712a "Users groups" is grammatically incorrect English - rename to "user groups"
Mads Kiilerich <madski@unity3d.com>
parents: 3306
diff changeset
78 - User groups for easier permission management
1405
9c6f39430aff Docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1206
diff changeset
79 - Repository groups let you group repos and manage them easier.
3184
6180e031a2b9 readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 2775
diff changeset
80 - Users can fork other users repos, and compare them at any time.
6180e031a2b9 readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 2775
diff changeset
81 - Integrates easily with other systems, with custom created mappers you can connect it to almost
6180e031a2b9 readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 2775
diff changeset
82 any issue tracker, and with an JSON-RPC API you can make much more
1488
dc16211e7292 Updated docs and contributors
Marcin Kuzminski <marcin@python-works.com>
parents: 1405
diff changeset
83 - Build in commit-api let's you add, edit and commit files right from RhodeCode
3184
6180e031a2b9 readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 2775
diff changeset
84 web interface using simple editor or upload binary files using simple form.
6180e031a2b9 readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 2775
diff changeset
85 - Powerfull pull-request driven review system with inline commenting,
6180e031a2b9 readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 2775
diff changeset
86 changeset statuses, and notification system.
6180e031a2b9 readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 2775
diff changeset
87 - Importing and syncing repositories from remote locations for GIT_, Mercurial_ and SVN.
1093
615c1bc11889 readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 1062
diff changeset
88 - Mako templates let's you customize the look and feel of the application.
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3184
diff changeset
89 - Beautiful diffs, annotations and source code browsing all colored by pygments.
3184
6180e031a2b9 readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 2775
diff changeset
90 Raw diffs are made in git-diff format for both VCS systems, including GIT_ binary-patches
6180e031a2b9 readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 2775
diff changeset
91 - Mercurial_ and Git_ DAG graphs and yui-flot powered graphs with zooming and statistics
6180e031a2b9 readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 2775
diff changeset
92 to track activity for repositories
847
75c425d0afeb updated readme
Marcin Kuzminski <marcin@python-works.com>
parents: 796
diff changeset
93 - Admin interface with user/permission management. Admin activity journal, logs
75c425d0afeb updated readme
Marcin Kuzminski <marcin@python-works.com>
parents: 796
diff changeset
94 pulls, pushes, forks, registrations and other actions made by all users.
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3184
diff changeset
95 - Server side forks. It is possible to fork a project and modify it freely
3184
6180e031a2b9 readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 2775
diff changeset
96 without breaking the main repository.
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3184
diff changeset
97 - rst and markdown README support for repositories.
3184
6180e031a2b9 readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 2775
diff changeset
98 - Full text search powered by Whoosh on the source files, commit messages, and file names.
847
75c425d0afeb updated readme
Marcin Kuzminski <marcin@python-works.com>
parents: 796
diff changeset
99 Build in indexing daemons, with optional incremental index build
1093
615c1bc11889 readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 1062
diff changeset
100 (no external search servers required all in one application)
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3184
diff changeset
101 - Setup project descriptions/tags and info inside built in db for easy, non
3184
6180e031a2b9 readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 2775
diff changeset
102 file-system operations.
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3184
diff changeset
103 - Intelligent cache with invalidation after push or project change, provides
1167
312712050c7e fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 1127
diff changeset
104 high performance and always up to date data.
3184
6180e031a2b9 readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 2775
diff changeset
105 - RSS / Atom feeds, gravatar support, downloadable sources as zip/tar/gz
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3184
diff changeset
106 - Optional async tasks for speed and performance using celery_
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3184
diff changeset
107 - Backup scripts can do backup of whole app and send it over scp to desired
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3184
diff changeset
108 location
847
75c425d0afeb updated readme
Marcin Kuzminski <marcin@python-works.com>
parents: 796
diff changeset
109 - Based on pylons / sqlalchemy / sqlite / whoosh / vcs
0
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
110
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3184
diff changeset
111
676
bdd1ddd05b7c docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents: 643
diff changeset
112 Incoming / Plans
bdd1ddd05b7c docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents: 643
diff changeset
113 ----------------
241
48727add84c9 Made repos path config configurable from pylons app configs. update Readme
Marcin Kuzminski <marcin@python-works.com>
parents: 224
diff changeset
114
3184
6180e031a2b9 readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 2775
diff changeset
115 - Finer granular permissions per branch, or subrepo
6180e031a2b9 readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 2775
diff changeset
116 - Web based merges for pull requests
6180e031a2b9 readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 2775
diff changeset
117 - Tracking history for each lines in files
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3184
diff changeset
118 - Simple issue tracker
1093
615c1bc11889 readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 1062
diff changeset
119 - SSH based authentication with server side key management
615c1bc11889 readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 1062
diff changeset
120 - Commit based built in wiki system
3184
6180e031a2b9 readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 2775
diff changeset
121 - Gist server
1093
615c1bc11889 readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 1062
diff changeset
122 - More statistics and graph (global annotation + some more statistics)
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3184
diff changeset
123 - Other advancements as development continues (or you can of course make
1167
312712050c7e fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 1127
diff changeset
124 additions and or requests)
552
2642f128ad46 removed egg info, update files for distutils build
Marcin Kuzminski <marcin@python-works.com>
parents: 549
diff changeset
125
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
126 License
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
127 -------
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
128
1206
a671db5bdd58 fixed license issue #149
Marcin Kuzminski <marcin@python-works.com>
parents: 1167
diff changeset
129 ``RhodeCode`` is released under the GPLv3 license.
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
130
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
131
2020
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
132 Getting help
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
133 ------------
676
bdd1ddd05b7c docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents: 643
diff changeset
134
2020
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
135 Listed bellow are various support resources that should help.
676
bdd1ddd05b7c docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents: 643
diff changeset
136
2020
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
137 .. note::
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3184
diff changeset
138
2601
aa90719e8520 Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents: 2266
diff changeset
139 Please try to read the documentation before posting any issues, especially
aa90719e8520 Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents: 2266
diff changeset
140 the **troubleshooting section**
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3184
diff changeset
141
2020
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
142 - Join the `Google group <http://groups.google.com/group/rhodecode>`_ and ask
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
143 any questions.
676
bdd1ddd05b7c docs update, setup libs version bumps
Marcin Kuzminski <marcin@python-works.com>
parents: 643
diff changeset
144
2020
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
145 - Open an issue at `issue tracker <http://bitbucket.org/marcinkuzminski/rhodecode/issues>`_
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
146
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
147 - Join #rhodecode on FreeNode (irc.freenode.net)
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
148 or use http://webchat.freenode.net/?channels=rhodecode for web access to irc.
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
149
2034
3816bf3d0a5b readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 2020
diff changeset
150 - You can also follow me on twitter **@marcinkuzminski** where i often post some
2020
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
151 news about RhodeCode
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
152
796
47d5781bfe8a docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 727
diff changeset
153
47d5781bfe8a docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 727
diff changeset
154 Online documentation
47d5781bfe8a docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 727
diff changeset
155 --------------------
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
156
1093
615c1bc11889 readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 1062
diff changeset
157 Online documentation for the current version of RhodeCode is available at
2020
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
158 - http://packages.python.org/RhodeCode/
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
159 - http://rhodecode.readthedocs.org/en/latest/index.html
bedd7336908c docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
160
1093
615c1bc11889 readme update
Marcin Kuzminski <marcin@python-works.com>
parents: 1062
diff changeset
161 You may also build the documentation for yourself - go into ``docs/`` and run::
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
162
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
163 make html
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 564
diff changeset
164
1167
312712050c7e fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 1127
diff changeset
165 (You need to have sphinx_ installed to build the documentation. If you don't
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3184
diff changeset
166 have sphinx_ installed you can install it via the command:
1167
312712050c7e fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 1127
diff changeset
167 ``easy_install sphinx``)
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3184
diff changeset
168
869
0a099e4ad4bf fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents: 868
diff changeset
169 .. _virtualenv: http://pypi.python.org/pypi/virtualenv
0a099e4ad4bf fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents: 868
diff changeset
170 .. _python: http://www.python.org/
1167
312712050c7e fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 1127
diff changeset
171 .. _sphinx: http://sphinx.pocoo.org/
869
0a099e4ad4bf fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents: 868
diff changeset
172 .. _mercurial: http://mercurial.selenic.com/
1123
9472a0150bf0 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 1093
diff changeset
173 .. _bitbucket: http://bitbucket.org/
1167
312712050c7e fixed license in setup file, readme fixes
Marcin Kuzminski <marcin@python-works.com>
parents: 1127
diff changeset
174 .. _github: http://github.com/
869
0a099e4ad4bf fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents: 868
diff changeset
175 .. _subversion: http://subversion.tigris.org/
0a099e4ad4bf fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents: 868
diff changeset
176 .. _git: http://git-scm.com/
0a099e4ad4bf fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents: 868
diff changeset
177 .. _celery: http://celeryproject.org/
0a099e4ad4bf fixed readme for bb
Marcin Kuzminski <marcin@python-works.com>
parents: 868
diff changeset
178 .. _Sphinx: http://sphinx.pocoo.org/
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3184
diff changeset
179 .. _vcs: http://pypi.python.org/pypi/vcs