docs/. README

[Dimi Paun]

ChangeSet ID:	1122352252428650742936046
CVSROOT:	/cvsroot/wine
Module name:	docs
Changes by:	[e-mail]	2005/07/25 21:30:52

Modified files:
    .              : README

Log message:
    Add a little bit more about building the documentation.

Old revision  New revision  Changes     Path
 1.2           1.3           +54 -4      docs/README

Index: docs/README
diff -u -p docs/README:1.2 docs/README:1.3
--- docs/README	26 Jul 2005  4:30:52 -0000
+++ /dev/null	26 Jul 2005  4:30:52 -0000
@@ -1,6 +1,56 @@
-This is Wine's documentation repository. 
-You can find here various guides, translations, etc.
+1. INTRODUCTION

-For the main Wine repository, please refer to:
-    http://www.winehq.org/cvs
+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)
+   * 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 only a specific language, run:
+
+$ make <lang>
+
+Currently, we support English (en) and French (fr).
+
+-- 
+Dimi Paun 
+Lattica, Inc.