diff --git a/doc/technical/index.txt b/doc/technical/index.txt index 845b88346..147751f86 100644 --- a/doc/technical/index.txt +++ b/doc/technical/index.txt @@ -1,10 +1,16 @@ Technical Documentation ======================= +// Menu : prepend child backend +// Menu : prepend child proc +// Menu : prepend child gui +// 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:innerCore/the_inner_core.html[Lumiera the Inner Core] +get an *overview* of all the internals and components, you might want to read +link:overview.html[Lumiera the Inner Core] == Three Layers diff --git a/doc/technical/infra/index.txt b/doc/technical/infra/index.txt index e993d81e9..f1c903af9 100644 --- a/doc/technical/infra/index.txt +++ b/doc/technical/infra/index.txt @@ -6,8 +6,8 @@ Various details, documentation and other pieces of information regarding the infrastructure of the Lumiera project. This includes the infrastructure used for building and maintaining documentation and website. - * see link::../build/index.html[separate page for the Buildsystem] - * generating the link::MenuGen.html[navigation menu] for the website + * see link:../build/index.html[separate page for the Buildsystem] + * generating the link:MenuGen.html[navigation menu] for the website diff --git a/doc/technical/innerCore/DIR_INFO b/doc/technical/innerCore/DIR_INFO deleted file mode 100644 index 33f29ceb2..000000000 --- a/doc/technical/innerCore/DIR_INFO +++ /dev/null @@ -1,3 +0,0 @@ -Internal Design Overview - -Some rather sketchy document about design decisions and rationales diff --git a/doc/technical/innerCore/the_inner_core.txt b/doc/technical/overview.txt similarity index 98% rename from doc/technical/innerCore/the_inner_core.txt rename to doc/technical/overview.txt index 7bc9712ca..5688d9dad 100644 --- a/doc/technical/innerCore/the_inner_core.txt +++ b/doc/technical/overview.txt @@ -1,12 +1,13 @@ Lumiera: The Inner Core ======================= + [abstract] ****************************************************************************** -The Lumiera Developers have a vision about a modern core for a NLE. Here are -some of the design decisions and rationales in a rather sketchy way explained. -New Developers may find this Document useful to get an idea about how the -different components work together. +The Lumiera Developers have a distinct vision about the core of a modern NLE. +This document outlines some of the basic technical concepts and highlights +the fundamental design decisions. New Developers may find this Document useful +to get an idea about how the different components work together. ****************************************************************************** diff --git a/doc/user/index.txt b/doc/user/index.txt index 726244fa5..6b967999c 100644 --- a/doc/user/index.txt +++ b/doc/user/index.txt @@ -1,8 +1,11 @@ User Documentation ================== +// Menu : prepend child intro +// Menu : attach child 'manual' after 'intro' + * link:manual.html[User Manual] _(planned)_ * The following document might become an introductory overview: + - link:outerSpace/lumiera_from_outer_space.html[Lumiera (as seen) from Outer Space] - * link:outerSpace/Glossary.html[Glossary of common terms] + link:intro/intro.html[Lumiera (as seen) from Outer Space] + * link:intro/Glossary.html[Glossary of common terms] diff --git a/doc/user/outerSpace/Glossary.txt b/doc/user/intro/Glossary.txt similarity index 100% rename from doc/user/outerSpace/Glossary.txt rename to doc/user/intro/Glossary.txt diff --git a/doc/user/outerSpace/lumiera_from_outer_space.txt b/doc/user/intro/intro.txt similarity index 99% rename from doc/user/outerSpace/lumiera_from_outer_space.txt rename to doc/user/intro/intro.txt index 397647a7d..1bc008b7c 100644 --- a/doc/user/outerSpace/lumiera_from_outer_space.txt +++ b/doc/user/intro/intro.txt @@ -1,6 +1,7 @@ Lumiera (as seen) from Outer Space ================================== -Christian Thäter +:Author: Christian Thäter ct@pipapo.org +:Date: Summer 2010 [abstract] diff --git a/doc/user/outerSpace/lumiera_big_graph.svg b/doc/user/intro/lumiera_big_graph.svg similarity index 100% rename from doc/user/outerSpace/lumiera_big_graph.svg rename to doc/user/intro/lumiera_big_graph.svg diff --git a/doc/user/outerSpace/lumiera_screenshot.png b/doc/user/intro/lumiera_screenshot.png similarity index 100% rename from doc/user/outerSpace/lumiera_screenshot.png rename to doc/user/intro/lumiera_screenshot.png diff --git a/doc/user/tutorials/building.txt b/doc/user/tutorials/building.txt index 81347aa92..8bddcb93b 100644 --- a/doc/user/tutorials/building.txt +++ b/doc/user/tutorials/building.txt @@ -193,3 +193,12 @@ cd bin You should see something like (screenshot from 1/2009): image:/media/img/design.gui/screenshot090124-resources.jpg[] + + +What's next? +------------ +If you're a coder, maybe you've found something to improve...? + +Contributing to Lumiera is made easy, thanks to *Git* + +-> Tutorial link:contributing.html[Contributing to Lumiera coding] + diff --git a/doc/user/tutorials/contributing.txt b/doc/user/tutorials/contributing.txt index e7ff9e4ec..df10c1a0d 100644 --- a/doc/user/tutorials/contributing.txt +++ b/doc/user/tutorials/contributing.txt @@ -1,20 +1,27 @@ Contributing to Lumiera ======================= -Nothing is easier, follow the -http://www.kernel.org/pub/software/scm/git/docs/gittutorial.html[the basic -instructions], notably the following parts: +The Lumiera project uses an infrastructure based on *Git*, the distibuted +sourcecode management software. This deliberately places the barrier for +contributing very low: No formal ``commit right'' is necessary; you can +start right away and present your first results in the _mob repository_. + +For starters, follow the +http://www.kernel.org/pub/software/scm/git/docs/gittutorial.html[basic +instructions] for using Git, notably the following parts: ------------------------------------------------------------ $ git config --global user.name "Your Name Comes Here" $ git config --global user.email you@yourdomain.example.com ------------------------------------------------------------ -Then you are ready to go, you can edit and commit the lumiera code locally in -your cloned repository. Please do small commits which fix/improve only one -single thing and use meaningful commit messages. +If you followed the link:building.html[building-lumiera tutorial], you created +already a local clone of the Lumiera repository. So you are ready to go, +you can edit build and commit your changes to the lumiera code locally in +your cloned repository. Please commit frequently, do small commits which +fix/improve only one single thing and use meaningful commit messages. -Check that you didn't break anything, by running the testsuite (see above) +Check that you didn't break anything, by running the testsuite. Finally you can push your changes to the lumiera server to the 'mob' repository: @@ -24,3 +31,5 @@ $ git push git://git.lumiera.org/lumiera/mob master:refs/heads/YOURNAME This creates a new branch 'YOURNAME' on the mob repository. Then you notify the other devs on the mailinglist and they may merge your code into the mainline. + +