marko10_000
/
openclonk
forked from Mirrors/openclonk
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
openclonk/docs
History
Tobias Zwick 21b722475e docs: constants are not displayed with brackets in the documentation anymore 2011-06-30 17:25:22 +02:00
..
images docs: replaced icons with new oc icons 2011-06-26 18:06:21 +02:00
sdk docs: constants are not displayed with brackets in the documentation anymore 2011-06-30 17:25:22 +02:00
Makefile docs: added empty index.xml as a starting point of the documentation (including the iframe) 2011-06-30 01:43:01 +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 docs: removed the RDW-documentation introduction page 2011-06-26 16:24:28 +02:00
Template.de.hhp docs: fix typo in Template.de.hhp 2011-06-29 14:20:36 +02:00
Template.hhk docs: removed the RDW-documentation introduction page 2011-06-26 16:24:28 +02:00
Template.hhp docs: replaced icons with new oc icons 2011-06-26 18:06:21 +02:00
bitmasks.js revert bitmasks.js removal 2011-06-29 15:03:53 +02:00
build_chm_files.py docs: replaced icons with new oc icons 2011-06-26 18:06:21 +02:00
clonk.dtd docs: constants are not displayed with brackets in the documentation anymore 2011-06-30 17:25:22 +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: constants are not displayed with brackets in the documentation anymore 2011-06-30 17:25:22 +02:00
de.po docs: constants are not displayed with brackets in the documentation anymore 2011-06-30 17:25:22 +02:00
doku.css docs: search.php works correctly with the iframe now 2011-06-30 02:23:21 +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 docs: added language switcher to the header 2011-06-30 01:41:49 +02:00
hhc.xsl docs: Workaround bugs in Microsofts hhc.exe 2010-02-15 23:53:22 +01:00
search.php docs: search.php works correctly with the iframe now 2011-06-30 02:23:21 +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.