Technical Documentation
=======================

// Menu :  prepend child library
// Menu :  prepend child vault
// Menu :  prepend child steam
// Menu :  prepend child stage
// Menu :  prepend child howto
// Menu :  prepend child overview


This documentation section contains technical documentation about Lumiera. To
get an *overview* of all the internals and components, you might want to read
link:overview.html[Lumiera the Inner Core]

== Three Layers

The technical documentation is split in three parts, one for each of the three
main layers of Lumiera. You may want to read the
link:{ldoc}/design/index.html[Design Documents] first to get an overview of all the
components.

* link:stage/index.html[*Stage Layer*] : Documents related to the GTK based Lumiera GUI
  
* link:steam/index.html[*Steam Layer*] : Documents regarding Session, models and the engine structure

* link:vault/index.html[*Vault Layer*] : Documents about the data and processing backend


== Tools

.Development
* link:/doxy/[*Doxygen* generated documentation] : API documentation of the Lumiera code.
* organisation of the link:code/index.html[Code Base] in general
* link:/x/CodingGuidelines.html[Coding Style] and further guidelines

.Building
* link:build/index.html[Buildsystem] : Installation & compilation tools, dependencies and packaging.

.HOWTO
* link:/x/DevHowto.html[Developer *HOWTOs*] : Collection of instructions, recipes, hints and similar
  materials intended for developers