From 991845a5bbfd5565b8d4657e36a391a2f918a369 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?G=C3=BCnther=20Brammer?= Date: Thu, 21 Feb 2013 22:34:52 +0100 Subject: [PATCH] docs: Update Makefile documentation and cygwin instructions --- docs/Makefile | 17 ++++++++++++----- docs/README.cygwin.txt | 9 +++++---- 2 files changed, 17 insertions(+), 9 deletions(-) diff --git a/docs/Makefile b/docs/Makefile index 3d5ff679e..34df7dc0f 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -1,8 +1,15 @@ -# Notable targets: -# all (default): German and English onlinedocs -# online-en: only English onlinedocs, which can be partially updated -# Enwickler.chm: the German offline doc -# use with make Entwickler.chm HHC = /path/to/hhc +# German and English online docs: +# make all +# make install prefix=/path/to/webspace +# The offline docs: +# make chm HHC=/path/to/hhc.exe + +# Only English online docs, which can be partially updated: +# make online-en +# The English offline doc: +# make chm/en/Developer.chm HHC=/path/to/hhc.exe +# XML syntax check: +# make check # Extra Parameters for xsltproc can be given in the XSLTFLAGS variable. # Use prefix to select the directory where the docs are to be installed diff --git a/docs/README.cygwin.txt b/docs/README.cygwin.txt index 816d3030f..997eeed0c 100644 --- a/docs/README.cygwin.txt +++ b/docs/README.cygwin.txt @@ -4,7 +4,7 @@ This section explains how to build the German and English HTML-documentation fro In Linux, it should be as easy as: Open the console and run make in this directory. -In Windows, you ned Python and Cygwin. During the Cygwin installation, select these additional libraries to install: +In Windows, you need Python and Cygwin. During the Cygwin installation, select these additional libraries to install: + make + xsltproc (libxml2 + libxslt + python-libxml2) + findutils @@ -12,7 +12,8 @@ In Windows, you ned Python and Cygwin. During the Cygwin installation, select th + gettext + gettext-devel + libgcrypt + libgpg-error (for whatever reason) -Also you might have to rename find.exe, so that the cygwin provided one is used - first in Windows\System32\dllback then in Windows\System32 to make sure it isn't used. -After the installation, run cygwin, cd to this directory (/cygdrive/c/.../openclonk/docs/) and run make. The process takes about ten minutes to complete. -The online version of the documentation has been generated into the online/ directory. \ No newline at end of file +After the installation, run cygwin, cd to this directory (/cygdrive/c/.../openclonk/docs/) and run make. The process takes a few minutes to complete. +The online version of the documentation has been generated into the online/ directory. + +To build the .chm files, install the html help compiler from http://www.microsoft.com/en-us/download/details.aspx?id=21138 or http://go.microsoft.com/fwlink/?LinkId=14188 and run make chm HHC=/path/to/hhc.exe