2013-10-25 06:34:38 +02:00
|
|
|
Documentation
|
|
|
|
|
=============
|
2013-04-12 03:42:46 +02:00
|
|
|
|
2010-11-14 03:38:43 +01:00
|
|
|
|
2010-12-06 04:40:06 +01:00
|
|
|
This documentation section contains documentation for both users and developers.
|
2010-11-18 22:21:48 +01:00
|
|
|
|
2011-04-01 20:44:03 +02:00
|
|
|
== User ==
|
2010-11-18 22:21:48 +01:00
|
|
|
|
2012-09-18 02:43:51 +02:00
|
|
|
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:
|
2010-11-18 22:21:48 +01:00
|
|
|
|
2011-02-13 04:42:02 +01:00
|
|
|
* link:user/manual.html[User Manual] _(planned)_
|
2010-11-18 22:21:48 +01:00
|
|
|
|
2011-04-01 20:44:03 +02:00
|
|
|
== Developer ==
|
2012-09-18 02:43:51 +02:00
|
|
|
Information about the structure and concepts Lumiera is based upon.
|
|
|
|
|
These documents give an overview on the main components of the application:
|
2010-11-14 03:38:43 +01:00
|
|
|
|
|
|
|
|
* link:design/index.html[Design Documents]
|
|
|
|
|
|
2010-11-18 22:21:48 +01:00
|
|
|
Programming-oriented details about the functional layers of Lumiera as well as a Doxygen documentation :
|
|
|
|
|
|
|
|
|
|
* link:technical/index.html[Technical Documents]
|
2011-11-27 06:15:35 +01:00
|
|
|
* link:technical/code/codingGuidelines.html[Style and Coding Guidelines]
|
2010-11-18 22:21:48 +01:00
|
|
|
|
2011-10-22 05:14:33 +02:00
|
|
|
=== 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.
|
|
|
|
|
|
2018-10-26 17:47:18 +02:00
|
|
|
-> access the Proc-Layer link:{l}/wiki/renderengine.html[TiddlyWiki online here]
|
2011-10-22 05:14:33 +02:00
|
|
|
|
2013-10-25 06:34:38 +02:00
|
|
|
=== API Documentation ===
|
2018-10-26 17:47:18 +02:00
|
|
|
We use the link:http://doxygen.org[Doxygen] tool to extract
|
2013-10-25 06:34:38 +02:00
|
|
|
code comments and generate code level API and reference documentation.
|
|
|
|
|
|
2018-10-26 17:47:18 +02:00
|
|
|
-> link:/doxy/index.html[Doxygen generated documentation]
|
2010-11-18 22:21:48 +01:00
|
|
|
|
2011-04-01 20:44:03 +02:00
|
|
|
== Media and Presentations ==
|
|
|
|
|
|
|
|
|
|
This section holds documents and materials used to present and promote Lumiera,
|
|
|
|
|
articles, summaries and whitepapers
|
|
|
|
|
-> link:/media/index.html[Index]
|
|
|
|
|
|
|
|
|
|
|
