Commit graph

3616 commits

Author SHA1 Message Date
3d03c19e04 combine recent documentation improvements done by Benny and Hendrik
resolved some edit conflicts in doc/user/intro/intro.txt
2013-08-20 04:35:32 +02:00
532a3614bd fix a broken RfC link 2013-08-20 04:18:36 +02:00
Hendrik Boom
0c135952d6 Minor grammatical and textual improvements in the documentation. 2013-04-11 21:42:46 -04:00
f7bb0fec03 WIP: First draft on How are Plugins Implemented.
This is very much WIP. Gone out a bit on a limb here in introducing a new
term LPI just to make it possible to explain the idea of interfaces and
plugins. Not sure if it really works though. The real test is, of course,
if it makes sense to someone reading this; or is just a load of jibberish!
2013-02-03 21:11:38 +01:00
b392276bed WIP: Vision, the all important section reworked.
The ping-pong continues: this is, yet again, another attempt
to tighten up the text on 'professionalism'.
As ever, corrections, suggestions, etc most welcome.
2013-02-03 02:23:46 +01:00
2b4d25a9d1 English improved: Global Pipes 2013-02-02 19:07:10 +01:00
72e10635ff @Hendrik: applied all your changes and decomposed them into individual topics.
please continue review/discussion on a separate banch, eg. by fetching ichthyo/documentation
2013-01-12 15:40:24 +01:00
Hendrik Boom
746af5bd11 WIP: changes to intro.txt : some questions 2013-01-12 15:33:06 +01:00
Hendrik Boom
d0480ce9cb WIP: changes to intro.txt : plug-ins 2013-01-12 15:32:50 +01:00
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
Hendrik Boom
2870278ebb WIP: a batch of changes to intro.txt 2013-01-12 14:55:56 +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
3723579d0d @Benny / Hendrik: merge back; now published some of the chages - plesase continue review/discussion... 2013-01-08 02:35:54 +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
845a6180f5 Initial draft of IRC meeting in October, 2012 2013-01-08 01:15:23 +01:00
98b9f03539 DOC & WIP: section vision -->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-06 17:33:54 +01:00
ea0be312e5 DOC: language corrected 2013-01-06 17:22:55 +01:00
01bb1cf184 DOC: Mostly language corrected, but a few rewrites.
Only just language corrections.
Reviewer might like to examine the following sections: Overview and GUI.

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-06 16:47:22 +01:00
8f479809b6 DOC: Language corrected.
No rewrite of sections, only the language was corrected. Only very
little rewriting, although some sections might be rewritten and improved
later.
A slight note on style: after a colon (i.e., ':') upper case or lower case
can follow. Both are corrected. To be consistent, I changed all to be the same,
i.e., lower case.
2013-01-06 16:16:58 +01:00
7327b1ffb0 add the September dev meeting summary (by cehteh) 2013-01-04 20:18:10 +01:00
501f92bc87 improved and slightly extended the design index page
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-04 01:45:47 +01:00
Hendrik Boom
c876bcffc3 vision section, small wording improvement 2013-01-03 23:41:36 +01:00
a7338c4d6c @Benny: all your work is included here... 2013-01-03 11:25:33 +01:00
54f3037098 DOC: "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-03 11:24:18 +01:00
ce3be0279c DOC/Intro: proposal for the Vision section 2013-01-03 11:22:42 +01:00
d12bb1f186 DOC/Intro: about this document
reword and expand the very first paragraph and add some cross links
2013-01-03 11:22:42 +01:00
f41d3221c8 remove the old "main" TiddlyWiki
now, the Proc-Layer TiddlyWiki is the only one to survive...
2013-01-03 11:22:41 +01:00
b5a1bb386c DOC/Intro: add some details regarding session storage 2013-01-03 11:22:41 +01:00
7bb403f637 Integrate from TiddlyWiki: some early IRC transcripts 2013-01-03 11:22:41 +01:00
8946cb7b6a DOC/Intro: more about assets 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
6856fb8846 DOC/Intro: expand on the global pipes (master bus section) 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