Documentation
=============


This documentation section contains documentation for both users and developers.

== User ==

As a start, you should visit the introductory text
link:user/intro/intro.html[Lumiera (as seen) from Outer Space]

A user manual containing the full reference for using Lumiera is planned:

 * link:user/manual.html[User Manual]  _(planned)_

== Developer ==
Information about the structure and concepts Lumiera is based upon.
These documents give an overview on the main components of the application:

 * link:design/index.html[Design Documents]

Programming-oriented details about the functional layers of Lumiera as well as a Doxygen documentation :

 * link:technical/index.html[Technical Documents]
 * link:technical/code/codingGuidelines.html[Style and Coding Guidelines]

=== the TiddlyWiki ===
Currently, Lumiera is still in the design- and evolution phase.
There is an embedded JavaScript wiki (TiddlyWiki) within the source tree, mostly
used as design notebook, featuring day-to-day design sketches, notes but also
quite some more persistent planning. Finished documentation text is constantly
moved over to the documentation section(s) of the Lumiera website.

-> access the Proc-Layer link:http://lumiera.org/wiki/renderengine.html[TiddlyWiki online here]

=== API Documentation ===
We use the link:http://www.doxygen.org/index.html[Doxygen] tool to extract
code comments and generate code level API and reference documentation.

-> link:http://lumiera.org/doxy/index.html[Doxygen generated documentation]

== Media and Presentations ==

This section holds documents and materials used to present and promote Lumiera,
articles, summaries and whitepapers
 -> link:/media/index.html[Index]