marko10_000
/
openclonk
forked from Mirrors/openclonk
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
openclonk/docs
History
Günther Brammer 6d6737a022 Add two new Material Shapes Octagon and Smoother, more chunk antialias 
Previously, smooth materials would get extra triangles at the top to create
slopes instead of steps. Now those also appear at the bottom.

Smooth also gets generally smoother at the bottom, while Rough gets rougher
at the top. The new Smoother material is somewhere between Flat and Smooth.
Octagon is like Flat but also gets straight slope triangles.
 		2011-09-07 14:25:32 +02:00
..
images new clonk-head graphics 2011-08-05 14:54:54 +02:00
sdk Add two new Material Shapes Octagon and Smoother, more chunk antialias 2011-09-07 14:25:32 +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 references to #strict 2011-07-04 15:31:34 +02:00
Template.de.hhp docs: fix typo in Template.de.hhp 2011-06-29 14:20:36 +02:00
Template.hhk docs: removed references to #strict 2011-07-04 15:31:34 +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: in the contents, also a list of all function is shown (instead of by version) 2011-07-20 01:18:03 +02:00
clonk.dtd docs: index page with "get started" links and search 2011-08-02 16:25:00 +02:00
clonk.py docs: Generate the table-of-contents <img> in the xslt 2011-06-30 19:25:02 +02:00
clonk.xsl docs: index page with "get started" links and search 2011-08-02 16:25:00 +02:00
de.po Add two new Material Shapes Octagon and Smoother, more chunk antialias 2011-09-07 14:25:32 +02:00
doku.css docs: index page with "get started" links and search 2011-08-02 16:25:00 +02:00
experimental.py Add Clonk Rage developer documentation 2009-05-09 15:11:51 +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 docs: fix link to download page in header.xml 2011-08-01 01:15:15 +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.