|
|
|
GridFlow 0.6.5 - reference index
|
|
|
|
|
|
|
Note |
first consult the file ../README for a vague idea on the meaning of
subdirectories.
|
|
Responsibilities |
| | Framework | matju | main.c,dim.c,bitpacking.c,grid.[ch],operator.c | |
Grid Processors | matju | grid_basic.c,grid_extra.c | |
Input/Output | matju | io.c,format*.c | |
Build Process | matju | configure,Makefile | |
Test Suite | matju | test1.c | |
Samples | matju | samples/* | |
Documentation | matju | doc/* | |
Help Files and Documentation Pictures | alx | help/*,doc/images/* | |
Java/Swing Extensions | matju | java/* | |
C Port | matju | nofts.[ch] | |
Max Port | ? | nil | |
Ruby Port | ? | nil | |
Extras | matju | extra/* | |
|
|
|
Release |
| |
Compatibility:
- 1 :
Should work with Ruby 1.6.6 and jMax 2.5.1 or PureData 0.35-0
Release steps (OPERATE WITH CAUTION):
- 1 : cvs tag gridflow_0_6_5 .
- 2 : mkdir gridflow
- 3 : cvs -d :pserver:anonymous@artengine.ca:/home/cvs/gridflow
export -r gridflow_0_6_5 -d gridflow .
- 4 : cd gridflow
- 5 : rm -rf CVS CVSROOT
- 6 : chmod -R go=u-w .
- 7 : cd ..
- 8 : tar cfzvv gridflow-0.6.5.tar.gz gridflow
- 9 : rm -rf gridflow # caution!!!
- 10 : scp gridflow*gz
matju@artengine.ca:/home/members/matju/gridflow/download
- 11 : mv gridflow*gz /home/matju/net/Gridflow
- 12 : ssh matju@artengine.ca :
expand tarball into jmax/gridflow/latest
- 13 : jmax/pd/0xff/ruby-talk mlists : post release
- 14 : freshmeat.net : post release
- 15 : RAA : post release
|
|
|
Documentation |
| |
- 1 :
Pictures formerly identified as "samples" should be screenshots of the
help files. The <sample> tag will be replaced by a <help> tag.
- 2 :
Pictures identified as help must be real help. The source code of
a template doesn't count as help.
- 3 :
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.
- 4 :
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.
- 5 :
Help-wise, Formats are considered objects.
Operators are to be documented as part of [@] and [@!].
- 6 :
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.
- 7 :
There are not help-thumbnails anymore in the reference manual
because they were not helpful.
- 8 :
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 Quick Reference:
environment variables
CVSEDITOR=pico
CVS_RSH=ssh2
|
|
|
GridFlow 0.6.5 Documentation
by Mathieu Bouchard matju@sympatico.ca
and
Alexandre Castonguay acastonguay@artengine.ca
|