============[How To Submit To The Archive -- Boilerplate 24 Jan, 1994]=========

We would love to have your submission.  
Here is how we would like you to submit it.
(If following this procedure is a problem, please tell us.)

START===============[If it all fits into ONE fileIn]===========================

1) Put the following Smalltalk COMMENT at the beginning of your file:
---------------------------[Not including this line]---------------------------
"       NAME            programName
        AUTHOR          your@email.address
        FUNCTION a one line description of the program
        ST-VERSIONS     2.5
        PREREQUISITES    any other (non-standard) files/devices required.
        CONFLICTS        anything you know it doesn't work with.
        DISTRIBUTION    world
        VERSION         Your version number
        DATE    The current date.
SUMMARY programName

	A multi-line description of your program.  At least a few lines,
   but no more than about a page.  Something like:

        Adds two options to the default StandardSystemController blue
   button menu.  `Wash Dishes' washes the dishes for you, and
   `Dry Dishes' dries them.  Look in the class commments for
   DirtyDish and CleanDish for more information and examples.
	As described in REFERENCE, and REFERENCE.
						Your Name
"!
----------------------------[Not including this line]-------------------------

2) Now fire up a VIRGIN copy of your Smalltalk distribution.
   (A copy you have NOT fixed/customized/routinely used...)

   Use the VIRGIN copy to fileIn any programs listed on the
   PREREQUISITES line from step 1, and then your programName.st
   submission.

3) At least minimally test it using this previously VIRGIN image.

4a) Use anonymous ftp to upload the file into the /incoming directory
    on st.cs.uiuc.edu.  Then immediately send email to 
    archive-manager@st.cs.uiuc.edu asking him to install the software.
	(Keep your original copy until it is installed.)

OR

4b) Now send email to archive-manager@st.cs.uiuc.edu

	a) Ask him to include your submission in section
	   gnu_st, little_st, papers, st80_pre4, st80_r4, st_v, etc.

	b) Include your programName.st file between the lines
BEGIN--cut-here--cut-here
END--cut-here--cut-here
	(We have a script which will look for those lines.)

[If you want to get fancy, include a "uuencode"d version of your
 file instead of a plain text version.  The script can handle that,
 and it improves the chances of your submission arriving intact.]

5) Wait for a "got it" message from someone here at uiuc.edu.
   If you haven't heard anything after 10 days, goto step 4.

6) Get your submission from the archive to double check
   that it made it ok.

7) Tell all your friends they can get this great code from.....
	[I suggest using the ~ftp/pub/Index file.]

8) [optional]  Suggest ways of improving this or any other 
   Smalltalk archive document.  
   (Even better submit improved versions ;-)

END=================[If it all fits into ONE fileIn]===========================
START===============[If it is too BIG for one fileIn]==========================

1) Get access to a UNIX(tm) machine, or ask the archive maintainer
   to fake up some instructions for your machine type.

2) Make a directory with a nice descriptive name.

	eg:  mkdir NiceDescriptiveName

[Bonus points for eight character names.]
[Eight character names STRONGLY suggested for Smalltalk/V submissions.]

3) Copy the source code for your submission into this directory.

	eg: cp ~/myStuff/* NiceDescriptiveName

[Bonus points for not using many subdirectories.]

4) Make a file called "CATALOG-CARD" which looks like the text
   between the "Not including this line" lines below.
   (This format is a "goodies-lib" defacto standard.  All the files
    under MANCHESTER follow this format.  Most of the others are 
    being slowly corrected to follow this standard.  [Exception ISA])

---------------------------[Not including this line]---------------------------
	NAME		NiceDecsriptiveName
        AUTHOR          your@email.address
        FUNCTION a one line description of the program
        ST-VERSIONS     2.5
	PREREQUISITES	
	THEN FILE IN	
	CONFLICTS WITH	
	DISTRIBUTION  	world
	VERSION	ID	Your version number  eg: 1.1
	VERSION DATE	The current date.    eg: 6 Jun 91
	SUMMARY

	This directory contains....
	A multi-line description of your program.
	Some getting started instructions.
	Other references.
	Etc.
						Your Name - Date
----------------------------[Not including this line]-------------------------

5) Remember that this is will be public and have your name on it.
   Test and double check accordingly.
   [Using a VIRGIN image is strongly suggested.]
   [The most common mistake is "I forgot to include.."]

6) Now make a compressed tar file (without using absolute path names)
   of your NiceDescriptiveName directory.

	eg: cd NiceDescriptiveName/..
	eg: tar -cvf NiceDescriptiveName.tar NiceDecriptiveName
	eg: compress NiceDescriptiveName.tar

7) Now you can either:

	a) Use anonymous ftp to upload the compressed tar file into
	   the /incoming directory on st.cs.uiuc.edu.  Then immediately 
	   send email to archive-manager@st.cs.uiuc.edu asking him to 
	   install the software.
		(Keep your original copy until it is installed.)

	b) Place the compressed tar file into a local ftp archive,
	   and ask archive-manager@st.cs.uiuc.edu to get and install it.

	c) Send archive-manager email asking about making
	   your submission via email.  DO NOT INCLUDE THE CODE
	   WITHOUT ASKING FIRST.  (The archive-manager alias
	   is an exploding alias, and multiple copies of a large 
	   submission could give our mail system indigestion!)

8) Wait for a "got it" message from someone here at uiuc.edu.
   If you haven't heard anything after 10 days, goto step 7.

9) Check the archive, to make certain everything looks ok.

10) Tell all your friends this great software is available at...
	[I suggest using the ~ftp/pub/Index file.]

8) [optional]  Suggest ways of improving this or any other 
   Smalltalk archive document.  
   (Even better submit improved versions ;-)

END=================[If it is too BIG for one fileIn]==========================