openclonk

History

Lukas Werling 3a59c15250 Add openclonk:// protocol handler (#1657 )		2019-01-02 17:16:09 +01:00
..
images	Add missing image in script gui docs.	2015-09-06 17:06:14 -04:00
sdk	Add openclonk:// protocol handler (#1657 )	2019-01-02 17:16:09 +01:00
tools	docs: Implement client-side search	2018-03-23 21:23:38 +01:00
Makefile	docs: Implement client-side search	2018-03-23 21:23:38 +01:00
README.cygwin.txt	docs: Update Makefile documentation and cygwin instructions	2013-02-21 22:41:01 +01:00
Template.de.hhp	docs: Improvements to chm generation and in-browser xslt preview	2011-09-09 21:36:03 +02:00
Template.hhp	docs: Improvements to chm generation and in-browser xslt preview	2011-09-09 21:36:03 +02:00
bitmasks.js	revert bitmasks.js removal	2011-06-29 15:03:53 +02:00
clonk.dtd	docs: Fix some typos found by make check	2013-02-24 14:50:12 +01:00
clonk.xsl	docs: Implement client-side search	2018-03-23 21:23:38 +01:00
de.po	docs: Implement client-side search	2018-03-23 21:23:38 +01:00
doku.css	docs: Implement client-side search	2018-03-23 21:23:38 +01:00
extra-strings.xml	docs: Generate the table-of-contents <img> in the xslt	2011-06-30 19:25:02 +02:00
header.xml	docs: Change http:// links to https	2018-03-20 21:59:47 +01:00
hhc.xsl	docs: split build_chm_files into build_contents, build_hhp and hhk.xsl	2011-09-19 14:50:27 +02:00
hhk.xsl	docs: split build_chm_files into build_contents, build_hhp and hhk.xsl	2011-09-19 14:50:27 +02:00
package-lock.json	docs: Implement client-side search	2018-03-23 21:23:38 +01:00
package.json	docs: Implement client-side search	2018-03-23 21:23:38 +01:00
search.js	docs: Fix case-sensitivity in search	2018-03-24 22:19:58 +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 need 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)

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