openclonk/docs
Maikel de Vries 59a09c3c3c Engine: Removed FIGHT procedure and all related stuff.
This is obsolete with new melee implementation and other authors should either use that or make something unique themselfs. Removed DFA_FIGHT, C4Script FnFightWith, ObjectActionFight, NoFight, OCF_FightReady, Fight Physical
2010-12-07 18:57:27 +01:00
..
images new header for the documentation (+de.po was re-generated by make) 2010-09-09 17:54:20 +02:00
sdk Engine: Removed FIGHT procedure and all related stuff. 2010-12-07 18:57:27 +01:00
Makefile Switch main documentation to English, German translation now in de.po (#287) 2010-08-22 15:13:17 +02: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.hhk Switch main documentation to English, German translation now in de.po (#287) 2010-08-22 15:13:17 +02:00
Template.de.hhp Switch main documentation to English, German translation now in de.po (#287) 2010-08-22 15:13:17 +02:00
Template.hhk Switch main documentation to English, German translation now in de.po (#287) 2010-08-22 15:13:17 +02:00
Template.hhp Switch main documentation to English, German translation now in de.po (#287) 2010-08-22 15:13:17 +02:00
build_chm_files.py Docs: Slightly update the script reference 2010-08-27 21:19:58 +02:00
clonk.dtd Switch main documentation to English, German translation now in de.po (#287) 2010-08-22 15:13:17 +02:00
clonk.py Switch main documentation to English, German translation now in de.po (#287) 2010-08-22 15:13:17 +02:00
clonk.xsl docs: Fix function <title>s 2010-09-25 00:47:33 +02:00
de.po Engine: Removed FIGHT procedure and all related stuff. 2010-12-07 18:57:27 +01:00
doku.css docs: Add tree lines to the contents 2010-04-17 01:55:11 +02:00
experimental.py Add Clonk Rage developer documentation 2009-05-09 15:11:51 +02:00
extra-strings.xml Switch main documentation to English, German translation now in de.po (#287) 2010-08-22 15:13:17 +02:00
header.xml Remove the php extension from the download URL 2010-12-03 22:48:34 +01:00
hhc.xsl docs: Workaround bugs in Microsofts hhc.exe 2010-02-15 23:53:22 +01:00
search.php updated header, en.po 2010-04-08 02:07:50 +02:00
xml2po.py docs: Generate a content.xml from build_chm_files instead of build_contents.pl 2010-02-16 02:48:06 +01: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.