marko10_000
/
openclonk
forked from Mirrors/openclonk
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
openclonk/docs
History
David Dormagen 8a8593e0ba Script GUI: added TightGridLayout style (requirement of #1842) 
The TightGridLayout fills spaces more aggressively. This is slower but makes for a tighter layout. Finding the best layout is NP-complete. This here is just O(N^2) or so.
 		2016-11-05 15:35:15 +01:00
..
images Add missing image in script gui docs. 2015-09-06 17:06:14 -04:00
sdk Script GUI: added TightGridLayout style (requirement of #1842) 2016-11-05 15:35:15 +01:00
Makefile Specifically run python2 instead of python from the docs Makefile. 2016-02-14 22:32:29 +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
build_contents.py Specifically run python2 instead of python from the docs Makefile. 2016-02-14 22:32:29 +01:00
build_hhp.py docs: split build_chm_files into build_contents, build_hhp and hhk.xsl 2011-09-19 14:50:27 +02:00
clonk.dtd docs: Fix some typos found by make check 2013-02-24 14:50:12 +01:00
clonk.py docs: Generate the table-of-contents <img> in the xslt 2011-06-30 19:25:02 +02:00
clonk.xsl docs: Enable navigation to cells in a table 2016-05-15 15:20:08 +02:00
de.po docs: Update de.po with the current english texts 2016-05-16 18:50:32 +02:00
doku.css docs: Fix contents position in really wide browser windows 2016-01-03 00:21:39 +01:00
experimental.py docs: split build_chm_files into build_contents, build_hhp and hhk.xsl 2011-09-19 14:50:27 +02:00
extra-strings.xml docs: Generate the table-of-contents <img> in the xslt 2011-06-30 19:25:02 +02:00
header.xml in the documentation, always have "docs" preselected in the search shown in the header 2016-06-19 17:00:18 +02: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
search.php website header changes 2013-10-31 00:58:55 +07: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 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