1. INTRODUCTION

Wine is a program which allows running Microsoft Windows programs
(including DOS, Windows 3.x and Win32 executables) on Unix.  It
consists of a program loader which loads and executes a Microsoft
Windows binary, and a library (called Winelib) that implements Windows
API calls using their Unix or X11 equivalents.  The library may also
be used for porting Win32 code into native Unix executables.

This package is Wine's documentation repository. It consists of 
various guides and their translations.

Wine and the Wine documenation is free software, released under 
the GNU LGPL; see the file LICENSE for the details.

2. QUICK START

To build the documentation, simply run:

$ ./configure; make

3. REQUIREMENTS

To build the Wine documentation, you must have:
   * make (GNU make recommended)
   * docbook-utils
   * openjade/opensp/sp  (on Fedora Code/SuSE/Debian respectively)
   * tetex (for .ps and .pdf output)

4. COMPILATION

The following output formats are currently supported:
   * ASCII      (.txt)
   * HTML       (.html)
   * PDF        (.pdf)
   * Postscript (.ps)

To build all the translations in all formats, simply run:

$ make

To build only a specific format, run:

$ make <format>

where <format> is one of txt, html, pdf, ps.

To build all formats of a specific language, run:

$ make <lang>

To build a specific format for a specific language, run:

$ cd <lang>; make <format>

Currently, we support English (en) and French (fr).
However, French is not built by default due to
bugs in the openjage/opensp/sp packages.

5. SENDING PATCHES

Here are the important points you should keep in mind when sending patches:
  * submit them to he Wine patches mailing list, wine-patches@winehq.org
  * include a ChangeLog entry with a description of the patch
  * keep the patch small and the point of the change clear
  * one patch per email
  * unified format only (diff -u)

For more information on composing and sending patches, please refer to:
    http://www.winehq.org/site/sending_patches

-- 
Dimi Paun <dimi@lattica.com>
Lattica, Inc.
