This documentation section contains technical documentation about Lumiera.
To get an overview of all the internals and components, you might want to read
Lumiera the Inner Core
Three Layers
The technical documentation is divided into three main parts and some supplements, corresponding to the code organisation in three layers. The information here can be very detailed and technical at times, and the topics are organised by individual components.
-
Stage Layer : Documents related to the GTK based Lumiera GUI
-
Steam Layer : Documents regarding Session, the models and the engine
-
Vault Layer : Documents about the data and processing backend
To better understand the underlying concepts, it might be helpful to also consult the Design Documents.
Tools
-
Doxygen : API documentation of the Lumiera code.
-
organisation of the Code Base in general
-
Coding Style and further guidelines
-
Buildsystem : Installation and compilation tools, dependencies and packaging.
-
Developer HOWTOs : Collection of instructions, recipes, hints, misdeeds and confessions and similar helpful resources for developers