benn/lumiera_documentation
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Minor changes on doc index and technical doc index

Browse source 
Intended to make pages more user friendly. Formatted pages structures and added text
This commit is contained in:
Simon Larcher 2010-11-18 22:21:48 +01:00
parent 4a161fb54d
commit 885c2c9ee7
2 changed files with 48 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
doc/index.txt
View file

@ -1,13 +1,28 @@
Documentation == Documentation
=============
All kinds of documentation goes here, both user and developer documentation.
* link:user/index.html[User Documentation] _(planned)_
* link:{l}/media/index.html[Whitepapers and Presentations]
* link:design/index.html[Design Documents]
* link:technical/index.html[Technical and Documentation]
[icon="warning.png"] [icon="warning.png"]
WARNING: Website under construction WARNING: Website under construction
This documentation section contains documentation for both users and developpers.
=== User
The user manual containing the full reference for using Lumiera :
* link:manual.html[User Manual] _(planned)_
=== Developper
Informations about the structure of Lumiera, they 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]
=== Presentation documents
Documents that you can use as you wish to present or promote Lumiera :
* link:white-papers-presentations.html[Whitepapers and Presentations]

24
doc/technical/index.txt
View file

@ -1,3 +1,4 @@
////
Technote Documentation Technote Documentation
====================== ======================
@ -10,4 +11,27 @@ Technote Documentation
[icon="warning.png"] [icon="warning.png"]
WARNING: Website under construction WARNING: Website under construction
////
== Technical Documentation
[icon="warning.png"]
WARNING: Website under construction
This documentation section contains technical documentation about Lumiera.
=== 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:design/index.html[Design Documents] first to get an overview of all the components.
* link:gui/index.html[*Graphical User Interface*] : Documents about the default GTK GUI that comes with Lumiera.
* link:proc/index.html[*Processing layer*]
* link:backend/index.html[*Backend system*]
=== Tools
.Development
* link:http://www.lumiera.org/doxy/[*Doxygen generated documentation*] : Complete reference for the code of Lumiera.
.Building
* link:build/index.html[*Buildsystem*] : Installation & compilation tools, dependencies and packaging.