~launchpad-pqm/launchpad/devel

« back to all changes in this revision

Viewing changes to doc/bazaar/README

  • Committer: David Allouche
  • Date: 2006-04-10 15:42:12 UTC
  • mto: This revision was merged to the branch mainline in revision 3511.
  • Revision ID: david.allouche@canonical.com-20060410154212-00dfdf7c4b4d10ce
README improvements

Show diffs side-by-side

added added

removed removed

Lines of Context:
4
4
This directory contains high level documentation describing the interactions of
5
5
the various non-web Launchpad subsystems that implement The Bazaar.
6
6
 
 
7
Compiling
 
8
=========
 
9
 
7
10
You can export the documentation to HTML and Postscript using, respectively,
8
11
``make html`` (that's the default target) and ``make ps``.
9
12
 
 
13
``make html`` requires ``xsltproc`` and ``dia``::
 
14
       sudo apt-get install xsltproc dia-gnome
 
15
 
 
16
``make ps`` requires ``texmacs`` and ``dia``::
 
17
       sudo apt-get install texmacs dia-gnome
 
18
 
 
19
 
10
20
Modifying
11
21
=========
12
22
 
13
23
Please read this section before modifying the documentation.
14
24
 
15
25
The documentation is written using GNU TeXmacs (``apt-get install texmacs``)
16
 
and is saved as ``bazaar.tmml``. TeXmacs has a crashing bug which is
17
 
exercised by ``unclutter`` (a little utility that hides the mouse cursor), so
18
 
you must kill ``unclutter`` to use TeXmacs. The first minutes of use tend to be
19
 
a bit painful when TeXmacs compiles a bunch fonts, please be patient, and start
20
 
``texmacs`` from a terminal so you get some idea of what is going on.
 
26
and is saved as ``bazaar.tmml``. You can make small changes directly on the
 
27
``bazaar.tmml`` file (that's an XML document), but using TeXmacs is strongly
 
28
recommended for any non-trivial editing.
 
29
 
 
30
TeXmacs has a crashing bug which is exercised by ``unclutter`` (a little
 
31
utility that hides the mouse cursor), so you must kill ``unclutter`` to use
 
32
TeXmacs. The first minutes of use tend to be a bit painful when TeXmacs
 
33
compiles a bunch fonts, please be patient, and start ``texmacs`` from a
 
34
terminal so you get some idea of what is going on.
 
35
 
 
36
If you have an trouble using TeXmacs, please ask David Allouche (ddaa).
21
37
 
22
38
All figures were created using ``dia`` (``apt-get install dia-gnome``) and are
23
39
stored in the ``dia`` and ``large-dia`` directories. The ``large-dia``