Commit graph

453 commits

Author SHA1 Message Date
Hendrik Boom
129e986d07 WIP: changes to intro.txt : visible universe 2013-01-12 15:32:33 +01:00
Hendrik Boom
5090dddcab WIP: changes to intro.txt : rendering is graph processing 2013-01-12 15:32:05 +01:00
Hendrik Boom
a1e15736f1 WIP: changes to intro.txt : "vision" section 2013-01-12 15:31:46 +01:00
Hendrik Boom
a5d2ce2066 WIP: changes to intro.txt : general wording improvements 2013-01-12 15:27:26 +01:00
08bae37de7 RFC: Scheduler Requirements
initial draft of an RfC to discuss and define the
requirements for other parts of the application to relie on
2013-01-09 12:27:45 +01:00
8ec3677cd2 WIP: why "not"?
isn't actually *being subject to* a wider goal
or an inner demand -- isn't that exactly the core
of the distinction between "professionality"
as opposed to an attitude of someone "just doing his job"?
2013-01-08 12:11:55 +01:00
a5022a6c79 DOC: test support tools - adapt to the changes recently done on master 2013-01-08 02:51:43 +01:00
3af661f45b WIP: Intro - section vision reworked -->careful review required.
No problem if changes/questions are done to this section. As this section is
so important, the reviewer may correct, add or even reject the corrections
here.

We'll get there, iteratively.
2013-01-08 02:27:54 +01:00
b548abd01e DOC: Intro - language corrected 2013-01-08 02:27:53 +01:00
Hendrik Boom
3769d0a183 WIP: Intro - vision section, small wording improvement 2013-01-08 02:27:53 +01:00
0b16047211 DOC: Intro - add section about this document and further reading
reword and expand the very first paragraph and add some cross links at the bottom
2013-01-08 02:27:53 +01:00
4e98ddbb8e WIP: Intro - proposal for the Vision section 2013-01-08 02:27:53 +01:00
a782f5843a DOC: Intro - expand on global pipes, assets and seesion storage 2013-01-08 02:27:53 +01:00
4670c563a9 WIP: Initial draft of IRC meeting in October, 2012 2013-01-08 02:27:53 +01:00
23040e9c7b WIP: "contributing"-tutorial, errors corrected, new sections.
Some obvious typos were corrected. Other material improved.
The section on Git was considerably improved.

An entirely new section on Git was added, but which contains some previous
material on git.
The reason for adding a new section on Git was I though it better to have one
single place where someone new to Git and Lumiera could read a simple
recipe-type explanation on how to retrieve source code, make changes and then
push the changes.  All information necessary including Git, links, etc should be
on this page, no following liknks. In fact there is no real _new_ information
here that isn't to be found somewhere else. The point being that _all_
information necessary to ge someone up and going is located on one page.

For this reason, I added information on the mailing list and IRC; again, all
essential information in how to contribute to Lumiera, the title ang goal of
this page.

There might be stuff missing here, so please add, but do not make this page too
long. That tends to scare people, in fact, someone might just like to shorten my
contributions here, that would be good!
2013-01-08 02:27:53 +01:00
d870692f36 DOC: player architecture, language corrected.
No rewrite of sections, only the language was corrected. Only very
little rewriting, although some sections might be rewritten and improved
later.
2013-01-08 02:16:48 +01:00
8790e2af46 DOC: design index page; language corrected, but a few rewrites.
TODO: Backend, needs just a little more, not much, e.g.:
      Area where low-level  memory, hardware i/o, etc occur => here
      is where real gain in efficiency through modern algorithms can occur,
      thus, achieving another goal of Lumiera: efficient & runs on all kinds
      of hardware!
2013-01-08 02:16:37 +01:00
21d2faff12 DOC: design index page improved and slightly extended
this is the entry point into the section holding the various
design documents -- we try to separatte conceptual/design
from the actual technical documentation
2013-01-08 01:55:31 +01:00
7327b1ffb0 add the September dev meeting summary (by cehteh) 2013-01-04 20:18:10 +01:00
7bb403f637 Integrate from TiddlyWiki: some early IRC transcripts 2013-01-03 11:22:41 +01:00
cec25b074e Integrate from TiddlyWiki: Pages about tests and test helpers 2013-01-03 11:22:41 +01:00
96fe3479dc DOC/Intro: some technical corrections and clarifications 2013-01-03 11:22:41 +01:00
17a3c407b6 DOC/Intro: typos and general clean-up
- spell check
- fixed formatting
- added grouping lanes (comments)
- flipped all the cross reference arrows
- removed some of the (resolved) TODO comments
- removed some planned sections, since these are rather technical
2013-01-03 09:29:31 +01:00
86b97169b2 DOC: building tutorial corrected 2013-01-03 09:29:04 +01:00
8a09414e46 DOC: Session Storage, very general introduction. 2013-01-03 00:53:26 +01:00
9a894e3719 DOC: The Visible Universe, language reworked. 2013-01-03 00:53:26 +01:00
c4470c1ba3 DOC: Fundamental Forces, language corrected.
Section Fundamental Forces corrected, all sub-sections corrected.
Some sub-sections slightly expanded for clarification purposes.
Some awkward expressrions removed, replaced or expanded.
2013-01-03 00:53:26 +01:00
764d21480e DOC: Section Vision completely reworked wrt language. 2013-01-03 00:53:26 +01:00
23cac22a9f Sync Documentation 2012-10-10 06:14:58 +02:00
2867dc1870 comment on the SemanticTags proposal 2012-10-10 06:11:32 +02:00
ee4e6905d2 Documentation: integrate the time quantisation concept pages
These pages from the TiddlyWiky feature a complete glossary
of terms relevant for time and timecode handling, plus the
architecural decisions related to this topic
2012-10-10 05:18:46 +02:00
64e6d37bb8 RFC architecture draft for metadata handling and serialisation 2012-10-08 06:53:22 +02:00
e6fa99b3dd commenting on website related RfC 2012-10-07 08:06:55 +02:00
17968bf109 create a submenu entry showing all RfC 2012-10-07 08:06:30 +02:00
f710095f6d adapt to newer Asciidoc syntax 2012-10-07 05:55:35 +02:00
e039c9391c RFC: draft a new RfC to describe required website authoring support tools 2012-10-07 05:55:12 +02:00
63cc4f4995 More corrections. Text for I/O 2012-09-18 02:46:56 +02:00
451c9c582e Added some intro stuff 2012-09-18 02:46:56 +02:00
fa8351248c Reworked at Froscon 2012 2012-09-18 02:46:56 +02:00
b01159c065 link the "Intro" text more prominently 2012-09-18 02:43:51 +02:00
d1558bbe95 Fix navigation for RfCs 2012-09-18 02:31:44 +02:00
Christian Thaeter
61e5a6a47b RFC: finalize GitCommitMessageFormat 2012-09-13 03:59:45 +02:00
Christian Thaeter
0c7e5822f0 RFC: some refinements about git commit messages
* when headers are used, then only the defined ones
* metadata may follow headers directly
* relax the absence if bugtracker data
2012-09-13 03:57:08 +02:00
Christian Thaeter
77a04f1e3f RFC: add ALPHA, BETA, RELEASE to the CommitMessage RFC 2012-09-13 01:40:04 +02:00
Christian Thaeter
34f45e28b2 add 'DONE' to the GitCommitMessage rfc 2012-09-12 21:58:11 +02:00
Christian Thaeter
5da7f0cd6e RFC: Git Commit Message Format
Formal description for the format of commit messages.
2012-08-31 04:47:01 +02:00
Christian Thaeter
5310d8a571 RFC: Tags 2012-08-30 21:53:26 +02:00
Christian Thaeter
aa60486066 apply the new RFC structure to existing RFC's 2012-08-30 20:50:08 +02:00
Christian Thaeter
7d964825d3 internal RFC reorganization
* rfcs are now all stored in the rfc folder (formerly hold the final rfcs)
* a new rfc_final folder is created
* the state folders (rfc_final|pending|parked|dropped) now contain
  symlinks back to the rfc pool
2012-08-30 20:50:08 +02:00
6eee5287d8 Glossary entries reworked and slightly expanded
- ProcessingGraph: text slightly expanded

 - Project: corrcted and text slightly modified

 - RenderTask: corrected

 - Viewer: corrected and somewhat modified

 - AssetsView corrected.

 - InputDevice
2012-08-25 19:20:05 +02:00
8e8c515272 Section: Plugins/Interfaces; introductory text.
First piece of introductory text for the Plugins/Interfaces
section. Only a somewhat long introduction of what plugins are.
TODO: discussed the 'what' of plugins, and possibly a little of
the 'why' of plugins, still require the 'how'.
2012-08-25 19:20:04 +02:00
8d43c00712 English corrected 2012-08-25 19:19:49 +02:00
92df23495a Glossery terms sorted 2012-08-25 19:19:49 +02:00
ca3838cb75 mention January meeting in the summaries page 2012-01-13 23:32:03 +01:00
956592dc0c publish meeting summary and scons-RfC (sync with master) 2012-01-13 23:30:34 +01:00
Christian Thaeter
55ff4e349c Meeting summary, January 2012 2012-01-12 15:49:40 +01:00
Christian Thaeter
0b2537bb89 RFC: bless scons as offical build system, final 2012-01-11 22:32:13 +01:00
Christian Thaeter
3be546a6b8 RFC: bless scons as offical build system 2012-01-11 22:31:03 +01:00
d2f83523ca join recent player subsystem work, SCons overhaul and documentation 2012-01-11 07:54:43 +01:00
feebd05cba create separate SConscript for documentation
currently just featuring Doxygen
2012-01-11 07:05:01 +01:00
f7a9414084 Documentation of the SCons buildsystem 2012-01-11 06:56:37 +01:00
0e08f269f5 remove the superfluous TiddlyWikis
..after integrating all still relevant asciidoced content
into the main website.
2012-01-11 06:55:54 +01:00
2bc5d3b367 document further library facilities, some clean-up 2012-01-08 00:14:05 +01:00
d2c5297a9d document our custom iterator concept 2012-01-08 00:13:23 +01:00
484149e73e add a section for library technical documentation 2012-01-08 00:12:54 +01:00
adc120fecb document the new formatting helper, based on boost::format 2011-12-31 07:54:16 +01:00
2d1e098d2c crosslink to the TypedID concept in the TiddlyWiki 2011-12-28 03:55:15 +01:00
1d7d63e27c document a hack for guessing implementation sizes 2011-12-28 03:40:39 +01:00
2791339841 some practical hints and informations regarding usage of the Boost Libraries
Add a page to the 'coding howto' section, listing those boost libraries we're
using heavily, with a short characterisation for each. Plus some informations
about potential problems
2011-12-26 05:54:56 +01:00
d27e3b15a9 clarify the handling of specific output operation modes (e.g. number of channels) 2011-12-23 02:22:38 +01:00
74a982409e document the internal structore of OutputSlot
...as far as decided and clarified by now
2011-12-20 04:59:00 +01:00
34d0622dd3 notes to the EngineInterface RfC 2011-12-16 20:25:34 +01:00
23d4202ec2 update StreamTypes RFC to our current standard RRF structure 2011-12-16 20:15:11 +01:00
c3bf3bb269 StreamTypes RFC: spelling and wording improvements 2011-12-16 20:15:02 +01:00
4b6f4fc140 StreamTypes RFC: spelling and wording improvements 2011-12-16 19:55:24 +01:00
d6f5ed3282 technical overview: document some library and support facilities 2011-12-10 03:15:40 +01:00
336d4cb33f technical overview: player and engine interface 2011-12-10 01:52:51 +01:00
11f0438942 spelling and some small additions 2011-12-10 01:41:21 +01:00
8e45412513 supplementing a transcript from the IRC log (11/2008) 2011-12-01 22:48:30 +01:00
0399ea1313 we're missing an important meeting from 2008.
this is the raw transcript, needs to be shortened
2011-12-01 16:38:23 +01:00
00813a0169 long standing issue: a style guide page 2011-11-27 06:15:35 +01:00
16e41852ba mention the TiddlyWiki on the documentation root page 2011-10-22 05:14:33 +02:00
fb48ec70f0 resync with current documentation on the Website 2011-10-21 02:03:01 +02:00
bb2ca862ac reference distribution for building is now Debian/Squeeze 2011-10-21 01:53:05 +02:00
f0b443abde add a page for documenting shady details and other smells 2011-10-14 22:46:04 +02:00
e1854ec490 Add Debian packaging informations to the documentation 2011-10-14 03:36:36 +02:00
5269904e06 New documentation section for code base layout and conventions 2011-10-14 03:35:39 +02:00
924944f607 write down some know-how regarding standard hash functions 2011-10-14 01:10:16 +02:00
f8842c75ed WIP draft OutputSlot internal transitions 2011-09-25 19:26:01 +02:00
9f7a46110b fix labels in UML 2011-09-25 19:26:01 +02:00
dea1fa57a2 draft play process structure; clarify handling of multiple channels 2011-09-25 19:25:58 +02:00
9bd96a1b19 time-entities refactoring: Duration isn't an Offset
removed that inheritance relation; it was a typical
example of abusing inheritance and violated the
Liscov substitution principle. It is sufficient
to allow promotion of an offset into a Duration.
Note: Duration is the time metric
2011-09-25 19:25:53 +02:00
5e8a9b50d1 define asset::Viewer 2011-09-25 19:25:52 +02:00
1ad48be1b6 sync with current dok tree 2011-09-25 19:20:46 +02:00
Stefan Kangas
2547580d31 Fix typo in website menu 2011-09-15 02:32:31 +02:00
64cf3c9d34 update GDB-pretty-printer HOWTO
Eclipse now supports structured display of STL containers
2011-08-25 03:03:43 +02:00
c6f4f9bf25 create pages and sections for the design of output handling and player subsystem
Signed-off-by: Ichthyostega <prg@ichthyostega.de>
2011-05-22 05:45:59 +02:00
51b3f0defa start a page to collect technical notes about Scheduler and Jobs (Backend)
Signed-off-by: Ichthyostega <prg@ichthyostega.de>
2011-05-22 00:50:23 +02:00
cd57901d52 sync documentation with current master 2011-05-15 04:07:30 +02:00
82ca6ef7ea add subsections, further tidying of the transcript
Signed-off-by: Ichthyostega <prg@ichthyostega.de>
2011-05-15 03:58:44 +02:00
5ace6db895 shortened the transcript 2011-05-15 03:08:37 +02:00
f435e8d19c Update dev meeting TOC, add raw IRC transcript of May meeting
Signed-off-by: Ichthyostega <prg@ichthyostega.de>
2011-05-15 01:26:51 +02:00
54d1e4336c symlink to README doesn't make much sense...
there is index.txt already for that purpose (overview of documentation section), while README is
for the general source tree, and not intended for the website
2011-05-15 00:30:25 +02:00
Christian Thaeter
4d7ac84c60 trying to symlink the README from the doc 2011-05-12 20:01:33 +02:00
c49c7b5fdd new RfC: Engine Interface Specification 2011-05-11 21:06:45 +02:00
3c9c145f7b promote the Engine Interface Overview to draft state 2011-05-11 21:06:25 +02:00
c05c9f6fb3 finish player subsystem design document
Signed-off-by: Ichthyostega <prg@ichthyostega.de>
2011-05-11 03:08:27 +02:00
e12d99c6ff expand on the requiremenst for the player subsystem
Signed-off-by: Ichthyostega <prg@ichthyostega.de>
2011-05-10 02:49:31 +02:00
b83c7dea3b Start collection design elements of the Player subsystem
Signed-off-by: Ichthyostega <prg@ichthyostega.de>
2011-05-08 19:12:35 +02:00
Christian Thaeter
48f5e154a0 New RFC about factoring liblumiera out into a spinoff subproject 2011-04-22 11:47:10 +02:00
3b91a129f2 update the short summary of the Apr.2011 meeting
Signed-off-by: Ichthyostega <prg@ichthyostega.de>
2011-04-19 05:42:21 +02:00
7af4779b0e Finish the meeting summary
Further reduced the quoted transcript, summarise some discussions, add conclusions and subheadings
2011-04-19 05:33:55 +02:00
d3d7f0e45d checkpoint: meeting summary shortened IRC log 2011-04-16 04:15:20 +02:00
a3dd83c0f0 move all existing IRC meeting summaries from the website into the core tree
Note: the documentation subtree is included in the website, so the
meeting summaries are still visible online
2011-04-16 02:47:56 +02:00
eb087b98b1 re-read some of the RfC, fix small markup issues 2011-04-16 02:47:42 +02:00
Christian Thaeter
207fa7c13c Add link to the rfc.sh documentation 2011-04-14 19:22:04 +02:00
Christian Thaeter
dc8dd98308 FIX: asciidoc formating glitches, rfc.sh documentation 2011-04-14 19:14:03 +02:00
Christian Thaeter
8b6ce26110 FIX: next attempt to tame the menugen script (I promise I RTFM next time) 2011-04-14 04:25:43 +02:00
Christian Thaeter
be6a60dd25 add menu entry for new rfc_parked dir 2011-04-14 04:16:32 +02:00
Christian Thaeter
69786d2b2e Changes/Updates on the RFC documents as decided on the Developer meeting 2011-04-14 03:47:16 +02:00
Christian Thaeter
88d59a9e1b moved parked RFC's into the new rfc_parked dir 2011-04-14 02:52:06 +02:00
Christian Thaeter
5beeba0b7f create a new dir for 'parked' RFC's 2011-04-14 02:51:00 +02:00
1e1c3706dc update some DIR_INFO entries 2011-04-05 00:44:30 +02:00
de07ca03f4 fix some Title levels 2011-04-01 20:44:03 +02:00
7275720812 fix menu entry 2011-03-31 20:50:33 +02:00
012ed9ab36 update intro, fix image links
Signed-off-by: Ichthyostega <prg@ichthyostega.de>
2011-03-31 20:44:03 +02:00
8e15e1dec0 update the compiling-from-source tutorial
Signed-off-by: Ichthyostega <prg@ichthyostega.de>
2011-03-31 19:53:56 +02:00
ef4545bc55 augment the debian packaging and repository documentation 2011-03-28 07:01:12 +02:00
90caeaee6c Create new section for architecture design docs
Signed-off-by: Ichthyostega <prg@ichthyostega.de>
2011-03-28 04:02:27 +02:00
5e4d3a3ca0 tutorial for building from a debian source package
Signed-off-by: Ichthyostega <prg@ichthyostega.de>
2011-03-14 02:24:49 +01:00
5bb9250ddb page to document the debian packaging and depot management 2011-03-13 08:35:04 +01:00
Christian Thaeter
95edf9d478 Merge remote branch 'documentation/documentation' into documentation
* documentation/documentation:
  Change screenshot in the build tutorial to be smaller.
2011-03-10 01:32:28 +01:00
Christian Thaeter
7e17839c91 Add some short description about the tools and scripts in the ./admin dir 2011-03-10 01:31:44 +01:00
6abe23c926 sync documentation with current master 2011-03-10 01:19:39 +01:00
Stefan Kangas
827b395806 Change screenshot in the build tutorial to be smaller. 2011-03-10 01:11:57 +01:00
Christian Thaeter
b4f7613f81 Asciidoced documentation for rfc.sh and put it into the docs 2011-03-10 00:58:11 +01:00
72b62cb265 update documentation 2011-03-09 12:04:58 +01:00
472b1f7c75 new RfC: proposed Version numbering scheme 2011-03-09 03:05:22 +01:00
fa17e2594c corrections to the build tutorial (reported by Lars Knickrehm)
Signed-off-by: Ichthyostega <prg@ichthyostega.de>
2011-03-07 03:58:54 +01:00
ecb7d58a4f Merge changes to make Lumiera installable 2011-03-07 03:31:19 +01:00
Stefan Kangas
d05cfd01a4 State the specific dependencies for the GUI in the build tutorial.
Remove mention of old Ubuntu release.
2011-03-07 03:05:00 +01:00
Stefan Kangas
58a6303a4c Remove incorrect occurrences of glade being mentioned as a dependency. 2011-03-07 03:02:35 +01:00
3099fb7b11 reordering overview pages in User and Technical documentation 2011-03-04 02:48:31 +01:00
d67b5d7092 move in the meeting summary template from old website
Signed-off-by: Ichthyostega <prg@ichthyostega.de>
2011-03-01 03:29:22 +01:00
7c2b0f82a2 Proc-Layer technical documentation: refer to the TiddlyWiki 2011-02-28 01:25:27 +01:00
46d89aee7f reports & statistics page 2011-02-28 01:25:07 +01:00
1f559b883a Fix links and backlinks in RfC documents 2011-02-27 23:13:09 +01:00
3e9744b6ef Added Alcarinque's GUI proposal from 2008
my appologies that I've overlooked that
2011-02-27 23:12:29 +01:00
07804bed2c integrate the RfC entries into the new website structure 2011-02-27 21:42:12 +01:00
3549867a07 Add a date and a historical note at the end 2011-02-22 11:15:14 +01:00