From 31beef22c1f976ee0d0b7d10157e726f234cff4e Mon Sep 17 00:00:00 2001 From: "N.N." Date: Tue, 4 Oct 2005 02:09:43 +0000 Subject: adding documentation in xml and html svn path=/trunk/; revision=3650 --- externals/gridflow/doc/project_policy.html | 98 ++++++++++++++++++++++++++++++ 1 file changed, 98 insertions(+) create mode 100644 externals/gridflow/doc/project_policy.html (limited to 'externals/gridflow/doc/project_policy.html') diff --git a/externals/gridflow/doc/project_policy.html b/externals/gridflow/doc/project_policy.html new file mode 100644 index 00000000..38790844 --- /dev/null +++ b/externals/gridflow/doc/project_policy.html @@ -0,0 +1,98 @@ + + +GridFlow 0.8.0 - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
 
+
+

GridFlow 0.8.0 -

+
    

Note

    +
+

Release

    +
+

Documentation

    +
+

CVS

    +
+

+
+

Note

+ first consult the file ../README for a vague idea on the meaning of + subdirectories.
 
+

Release

+Compatibility:
  • 1 : + Should work with Ruby 1.6.6 and PureData 0.36, 0.37, 0.38
+Release steps (
OPERATE WITH CAUTION
):
  • 1 : make vvtest # leak detection
  • 2 : ruby base/test.rb formats
  • 3 : cvs tag gridflow_0_7_7 .
  • 4 : mkdir gridflow
  • 5 : cvs -d :pserver:anonymous@cvs.gridflow.ca:/home/cvs/gridflow + export -r gridflow_0_7_7 -d gridflow .
  • 6 : cd gridflow
  • 7 : rm -rf CVS CVSROOT
  • 8 : chmod -R go=u-w .
  • 9 : cd ..
  • 10 : tar cfzvv gridflow-0.7.7.tar.gz gridflow
  • 11 : rm -rf gridflow # caution!!!
  • 12 : scp gridflow*gz gridflow@artengine.ca:download
  • 13 : mv gridflow*gz /home/matju/net/GridFlow
  • 14 : ssh gridflow@artengine.ca : expand tarball into public_html/latest
  • 15 : download somewhere else and try to compile
  • 16 : update main page
  • 17 : jmax/pd/ruby-talk mlists : post release (note: prefix subject with [ANN] !!!!)
  • 18 : freshmeat.net : post release
  • 19 : RAA : post release
 
+

Documentation

  • 1 : + Pictures identified as "<help>" should be screenshots of the + help files. They shouldn't be screenshots of the template.
  • 2 : + A Help file is a visual summary of what an object does. It should be + interactive and allow the user to understand what the object does. + Sample inputs are provided and sample results can be seen.
  • 3 : + All modifications to the documentation must be done in the XML. The + HTML must be kept up-to-date by rerunning "make" in the "doc/" directory.
  • 4 : + Help-wise, Formats are considered objects. + Operators are to be documented as part of [@] and [@!].
  • 5 : + Images grabbed directly from a jMax window should be encoded in PNG. + This includes "icons" (object boxes, message boxes, etc). If they are + in JPEG, only change to PNG when the image has to change anyway. + Distinguish "icons" from "thumbnails", the latter of which are scaled-down grabs, which should be encoded in JPEG.
  • 6 : + There are not help-thumbnails anymore in the reference manual + because they were not helpful.
  • 7 : + Large images should be kept out of the release. The release itself must + be small enough not to discourage us from doing releases and keeping + them all. It also should be downloadable on a bad modem. =) + Let's keep it under 500k please.
+in doc do: +for z in images/*.* images/*/*.*; do fgrep -q $z *.html || echo "$z"; done
 
+

CVS

+ environment variables + CVSEDITOR=pico + CVS_RSH=ssh2
 
+
+

+GridFlow 0.8.0 Documentation
+Copyright © 2001,2002,2003,2004,2005 by Mathieu Bouchard +matju@artengine.ca +

+
+ + -- cgit v1.2.1