documentation updates

[agent marmorkuchen]

hello there...

i updated the documentation a little. this is the first step in
revamping the documentation:

see:

http://github.com/marmorkuchen/groundcrew-viewer/commit/1a674a38a24d968ece31377551d7c3df0c2a9b56

howto_apps.txt describes how to create new applications for groundcrew
(not finished yet).
source_navigation.txt walks through the source and explains all elements
in detail.

these files are preliminarily set up as ASCII text files and are to be
transformed into wiki pages / inlined into source code later on.
what i would like to do with source_navigation is have the descriptions
next to the actual functions. this helps heaps not getting them out of
sync. then there should be two scripts: one is for deployment and strips
out the comments from the source files and the other one is for
extracting the documentation only (see rdoc, POD, epydoc, javadoc,
etc.). i will have to research if such a things exists for javascript.

cheers,
marmorkuchen

--
_ ascii ribbon campaign .oOo. GCSd-s:+aC++ULB+++W++M+PS+++Y+
( )
X For security reasons, all text in this mail is double-rot13 encrypted.
/ \

[Joe Edelman]

This is fantastic. I guess we could use the github wiki for the howto.

And yes, there's a 'jsdoc'.

--Joe

--
J.E. -- http://nxhx.org -- 413.250.8007