openclonk/docs
Julius Michaelis 02641b8baa Fix float()-docs: Typo in closing tag 2012-12-28 18:11:17 +01:00
..
images Merge default to floating-point 2012-03-22 18:02:48 +01:00
sdk Fix float()-docs: Typo in closing tag 2012-12-28 18:11:17 +01:00
Makefile docs: fix make -C docs install 2012-11-18 22:01:07 +01:00
README.cygwin.txt new header for the documentation (+de.po was re-generated by make) 2010-09-09 17:54:20 +02:00
Template.de.hhp Merge default to floating-point 2012-03-22 18:02:48 +01:00
Template.hhp Merge default to floating-point 2012-03-22 18:02:48 +01:00
bitmasks.js Merge default to floating-point 2012-03-22 18:02:48 +01:00
build_contents.py Merge default to floating-point 2012-03-22 18:02:48 +01:00
build_hhp.py Merge default to floating-point 2012-03-22 18:02:48 +01:00
clonk.dtd Merge default to floating-point 2012-03-22 18:02:48 +01:00
clonk.py Merge default to floating-point 2012-03-22 18:02:48 +01:00
clonk.xsl docs: Highlight new script value type keywords def and effect 2012-11-18 18:24:21 +01:00
de.po Merge branch 'master' into floating-point 2012-12-28 17:52:14 +01:00
doku.css doku.css with Endeavour font for titles 2012-05-13 10:32:12 +02:00
experimental.py Merge default to floating-point 2012-03-22 18:02:48 +01:00
extra-strings.xml Merge default to floating-point 2012-03-22 18:02:48 +01:00
header.xml fix openclonk header css for docs (nobody noticed :-( ) 2012-08-20 21:47:21 +02:00
hhc.xsl Merge default to floating-point 2012-03-22 18:02:48 +01:00
hhk.xsl Merge default to floating-point 2012-03-22 18:02:48 +01:00
search.php Merge default to floating-point 2012-03-22 18:02:48 +01:00
xml2po.py docs: xml2po doesn't ignore malformed xml files 2011-09-05 23:31:10 +02:00

README.cygwin.txt

How to build the documentation
==============================
This section explains how to build the German and English HTML-documentation from the English XML-source files and the translation file.

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:
+ make
+ xsltproc (libxml2 + libxslt + python-libxml2)
+ findutils
+ sed
+ 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.