diff --git a/___Documentation___ b/___Documentation___ new file mode 100644 index 000000000..2a7390788 --- /dev/null +++ b/___Documentation___ @@ -0,0 +1,9 @@ +|This is the Lumiera Documentation Tree| + +Lumiera documentation is meant to be self contained and included in the main tree. +The 'current' documentation is prepared, collected and tracked in a 'documentation' branch +of the main repository; there, documentation resides in the /doc subdirectory, while the +actual source goes into /src + +Moreover, the /doc subdirectory of the documentation tree is linked into the +Lumiera website. diff --git a/doc/design/builddrone/index.txt b/doc/design/builddrone/index.txt deleted file mode 100644 index 3fac0dc76..000000000 --- a/doc/design/builddrone/index.txt +++ /dev/null @@ -1,8 +0,0 @@ -Lumiera Builddrone -================== - -* link:BuildDroneConcept.html[initial concept from 2008] - -[icon="warning.png"] -WARNING: Website under construction - diff --git a/doc/design/index.txt b/doc/design/index.txt index 584c4873a..17cba192b 100644 --- a/doc/design/index.txt +++ b/doc/design/index.txt @@ -8,7 +8,6 @@ Lumiera Design Documents * link:backend/index.html[Backend] * link:application/index.html[Application] * link:plugins/index.html[Plug-ins] - * link:builddrone/index.html[Lumiera Builddrone] [icon="warning.png"] diff --git a/doc/design/model/index.txt b/doc/design/model/index.txt index 3aa841629..ab8fdbd66 100644 --- a/doc/design/model/index.txt +++ b/doc/design/model/index.txt @@ -1,6 +1,8 @@ Design Documents: Model ======================= + * two models: high-level and low-level + * RfC: link:{rfc}/../rfc_pending/ProcHighLevelModel.html[high-level model basics] [icon="warning.png"] WARNING: Website under construction diff --git a/doc/devel/rfc.txt b/doc/devel/rfc.txt new file mode 100644 index 000000000..8cc0638cd --- /dev/null +++ b/doc/devel/rfc.txt @@ -0,0 +1,13 @@ +Design Process +============== + +*TODO* describe how the design process works and what we denote by *RfC* + + * link:rfc[RfC accepted] + * link:rfc_pending[RfC pending] + * link:rfc_dropped[RfC dropped] + + +[icon="warning.png"] +WARNING: Website under construction + diff --git a/doc/devel/rfc_pending/ProcHighLevelModel.txt b/doc/devel/rfc_pending/ProcHighLevelModel.txt index b4e7cd839..4f8c6918f 100644 --- a/doc/devel/rfc_pending/ProcHighLevelModel.txt +++ b/doc/devel/rfc_pending/ProcHighLevelModel.txt @@ -57,7 +57,7 @@ _pull-based processing,_ but this is rather of no relevance for the high-level model. -image:images/high-level1.png[] +image:{imgd}/high-level1.png[] Normally, pipes are limited to a _strictly linear chain_ of data processors ("*effects*") working on a single data stream type, and consequently there is a @@ -101,7 +101,7 @@ mechaics, the wiring and configuration within the high-level model can be quite time dependant. -image:images/high-level2.png[] +image:{imgd}/high-level2.png[] Actually a *clip* is handled as if it was comprised of local pipe(s). In the example shown here, a two-channel clip has three effects attached, plus a @@ -119,7 +119,7 @@ adapted processing pipe. Example of an complete Session ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -image:images/high-level3.png[] +image:{imgd}/high-level3.png[] The Session contains several independent http://www.lumiera.org/wiki/renderengine.html#EDL[EDL]s plus an output bus diff --git a/doc/design/builddrone/BuildDroneConcept.txt b/doc/technical/build/BuildDroneDraft.txt similarity index 100% rename from doc/design/builddrone/BuildDroneConcept.txt rename to doc/technical/build/BuildDroneDraft.txt diff --git a/doc/technical/build/index.txt b/doc/technical/build/index.txt new file mode 100644 index 000000000..b9575cbd2 --- /dev/null +++ b/doc/technical/build/index.txt @@ -0,0 +1,15 @@ +Lumiera Buildsystem +=================== + +build -- continuous integration -- packaging + +* SCons +* Autotools +* Dependencies +* link:BuildDroneDraft.html[»Builddrone« concept from 2008] +* packaging: Debian RPM +* Lumiera debian depot + +[icon="warning.png"] +WARNING: Website under construction + diff --git a/doc/technical/index.txt b/doc/technical/index.txt index 75867969b..04bc29490 100644 --- a/doc/technical/index.txt +++ b/doc/technical/index.txt @@ -5,6 +5,7 @@ Technote Documentation * link:gui/index.html[GUI-Layer] * link:proc/index.html[Proc-Layer] * link:backend/index.html[Backend] + * link:build/index.html[Buildsystem] [icon="warning.png"]