← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to README

  • Committer: Martin Pool
  • Date: 2005-03-14 07:07:24 UTC
  • Revision ID: mbp@sourcefrog.net-20050314070724-ba6c85db7d96c508
- add setup.py and install instructions
- rename main script to just bzr

Show diffs side-by-side

added added

removed removed

Lines of Context:
README
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
 
The only dependency is Python, at least 2.3 and preferably 2.4.
28
 
 
29
 
You may optionally install cElementTree to speed up some operations.
 
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
 
30
34
 
31
35
 
32
36
Installation
33
37
------------
34
38
 
35
 
The best way to install bzr is to symlink the ``bzr`` command onto a
36
 
directory on your path.  For example::
37
 
 
38
 
  ln -s ~/work/bzr/bzr ~/bin/bzr
39
 
 
40
 
If you use a symlink for this, Python will be able to automatically
41
 
find the bzr libraries.  Otherwise you must ensure they are listed on
42
 
your $PYTHONPATH.
 
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.