~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to README

  • Committer: Martin Pool
  • Date: 2005-05-05 06:38:18 UTC
  • Revision ID: mbp@sourcefrog.net-20050505063818-3eb3260343878325
- do upload CHANGELOG to web server, even though it's autogenerated

Show diffs side-by-side

added added

removed removed

Lines of Context:
24
24
This is mostly developed on Linux (Ubuntu); it should work on Unix,
25
25
Windows, or OS X with relatively little trouble.
26
26
 
27
 
bzr requires a fairly recent Python, say after 2.2.  2.4 is recommended.
28
 
 
29
 
You must install either cElementTree_ or ElementTree_ first.
30
 
 
31
 
.. _cElementTree: http://effbot.org/zone/celementtree.htm
32
 
.. _ElementTree: http://effbot.org/zone/element-index.htm
33
 
 
 
27
The only dependency is Python, at least 2.3 and preferably 2.4.  On
 
28
Windows, Python2.4 is required.
 
29
 
 
30
You may optionally install cElementTree to speed up some operations.
34
31
 
35
32
 
36
33
Installation
37
34
------------
38
35
 
39
 
bzr has a standard python ``setup.py`` script.  
40
 
 
41
 
To install it system-wide::
42
 
 
43
 
  # python ./setup.py install
44
 
 
45
 
Alternatively you can simply put the source directory on $PYTHONPATH
46
 
and $PATH.
 
36
The best way to install bzr is to symlink the ``bzr`` command onto a
 
37
directory on your path.  For example::
 
38
 
 
39
  ln -s ~/work/bzr/bzr ~/bin/bzr
 
40
 
 
41
If you use a symlink for this, Python will be able to automatically
 
42
find the bzr libraries.  Otherwise you must ensure they are listed on
 
43
your $PYTHONPATH.
 
44
 
 
45
If you use the setup.py script then bzr will be installed into the
 
46
specified path.  In this case you must install ElementTree or
 
47
cElementTree separately.
 
48