1.1 --- a/README	Thu Mar 12 15:52:36 2009 +0800
     1.2 +++ b/README	Fri Sep 04 16:56:01 2009 +0200
     1.3 @@ -1,99 +1,16 @@
     1.4 -HOW-TO:  Compiling the Mercurial Book
     1.5 -======================================
     1.6 +Mercurial: The Definitive Guide
     1.7 +-------------------------------
     1.8  
     1.9 -This Mercurial Book is written in DocBook 4.5.
    1.10 +Welcome to the source code for the book.  You can clone the definitive
    1.11 +copy of the source tree using Mercurial as follows:
    1.12  
    1.13 -The goal of this document is to give simple instructions to anyone who
    1.14 -wants to compile this book into a useful format, like HTML or PDF.  It
    1.15 -should state *exactly* which tools to use, and how to invoke them, in
    1.16 -simplest terms.
    1.17 +  hg clone http://hg.serpentine.com/mercurial/book
    1.18  
    1.19 -Table of Contents:
    1.20 +Here's a top-level tour of interesting directories:
    1.21  
    1.22 -  I. PRIMER
    1.23 - II. COMPILING THE DOCS
    1.24 -III. HACKING ON THE DOCS
    1.25 -
    1.26 -I. PRIMER
    1.27 -
    1.28 -  DocBook has a tortured, confusing history.  Before you do anything,
    1.29 -  take a look at Eric Raymond's excellent "DocBook Demystification HOWTO":
    1.30 -
    1.31 -      http://tldp.org/HOWTO/DocBook-Demystification-HOWTO/
    1.32 -
    1.33 -  It's very short and clears up many things.
    1.34 -
    1.35 -
    1.36 -II. COMPILING THE DOCS
    1.37 -
    1.38 -
    1.39 -1. Install XML DTD and XSL stylesheets for DocBook
    1.40 -
    1.41 -      % sudo apt-get install docbook-xml docbook-xsl
    1.42 -
    1.43 -2. Install libxml2-utils
    1.44 -
    1.45 -      % sudo apt-get install libxml2-utils
    1.46 -
    1.47 -3. Install graph drawing tools
    1.48 -
    1.49 -      % sudo apt-get install graphviz inkscape
    1.50 -
    1.51 -4. Install pdf support
    1.52 -
    1.53 -      % sudo apt-get install openjdk-6-jdk docbook-xsl-saxon libsaxon-java fop
    1.54 -
    1.55 -  The Makefile will actually invoke tools/fop/fop.sh, you should do
    1.56 -  some trick, let fop's CLASSPATH include saxon.jar and docbook-xsl-saxon.jar .
    1.57 -
    1.58 -5. Make
    1.59 -  Run 'make' for more details, for example:
    1.60 -
    1.61 -  * make all document(pdf, html and html-single for all languages)
    1.62 -      % make all
    1.63 -
    1.64 -  * make english document(pdf, html and html-single for all languages)
    1.65 -      % make LINGUA=en all
    1.66 -
    1.67 -  * make Chinese document(pdf, html and html-single for all languages)
    1.68 -      % make LINGUA=zh all
    1.69 -
    1.70 -  * make Chinese pdf document
    1.71 -      % make LINGUA=zh pdf
    1.72 -
    1.73 -III. HACKING ON THE DOCS
    1.74 -
    1.75 -In addition to everything in section II:
    1.76 -
    1.77 -
    1.78 -1. Get a nice editing environment for SGML/XML.
    1.79 -
    1.80 -  This isn't strictly required, but it's nice when your editor
    1.81 -  colorizes things, understands the DTD, tells you what tags you can
    1.82 -  insert, etc.
    1.83 -
    1.84 -  If you use emacs, we recommend the PSGML major-mode.  Most free
    1.85 -  operating systems package it, or its home page is here:
    1.86 -
    1.87 -      http://www.lysator.liu.se/projects/about_psgml.html
    1.88 -
    1.89 -  If you use vim, you might check out xmledit, at:
    1.90 -
    1.91 -      http://www.vim.org/scripts/script.php?script_id=301
    1.92 -
    1.93 -
    1.94 -2. Get a validating parser.
    1.95 -
    1.96 -  Actually, if you have what you need to compile the documentation,
    1.97 -  then you almost certainly have an XML validator installed already -
    1.98 -  it is called xmllint, and comes as part of libxml2.
    1.99 -
   1.100 -  The makefile is preconfigured with a suitable invocation of it,
   1.101 -  so simply run:
   1.102 -
   1.103 -      $ make validate
   1.104 -
   1.105 -3. Read about DocBook.
   1.106 -
   1.107 -  You'll want to get real intimate with a DocBook reference, such as
   1.108 -  can be found at:  http://www.docbook.org/tdg/en/html/
   1.109 +en        English-language content
   1.110 +es        Spanish-language content
   1.111 +examples  Miscellaneous example scripts
   1.112 +tools     Old, largely unused conversion scripts
   1.113 +web       Content and comment system for http://hgbook.red-bean.com/
   1.114 +xsl       XSLT scripts for generating HTML