~launchpad-pqm/launchpad/devel

« back to all changes in this revision

Viewing changes to doc/bazaar/README

  • Committer: David Allouche
  • Date: 2006-02-17 00:49:50 UTC
  • mfrom: (0.2.9 bzr-launchpad)
  • mto: This revision was merged to the branch mainline in revision 3511.
  • Revision ID: david.allouche@canonical.com-20060217004950-d89e0bcbf359575e
merge TheBazaar documentation

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
Bazaar Documentation
 
2
====================
 
3
 
 
4
This directory contains high level documentation describing the interactions of
 
5
the various non-web Launchpad subsystems that implement The Bazaar.
 
6
 
 
7
You can export the documentation to HTML and Postscript using, respectively,
 
8
``make html`` (the default target) and ``make ps``.
 
9
 
 
10
Modifying
 
11
=========
 
12
 
 
13
Please read this section before modifying the documentation.
 
14
 
 
15
The documentation is written using GNU TeXmacs (``apt-get install texmacs``)
 
16
and is saved as ``bzr-launchpad.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.
 
21
 
 
22
All figures were created using ``dia`` (``apt-get install dia-gnome``) and are
 
23
stored in the ``dia`` and ``large-dia`` directories. The ``large-dia``
 
24
directory contains images which would be exported by default to a width greater
 
25
than 600 pixels.
 
26
 
 
27
If you modify a diagram from the ``large-dia`` directory, you should export it
 
28
manually from ``dia`` and set the width to be at most 600 pixels. Then run
 
29
``make large-dia/sizes`` to record the new size of the exported PNG file. This
 
30
is necessary because the ``dia`` command line does not support image export
 
31
with aspect-ratio preserving scaling.