home *** CD-ROM | disk | FTP | other *** search
/ Programmer's ROM - The Computer Language Library / programmersrom.iso / ada / general / submit.doc < prev    next >
Encoding:
Text File  |  1988-05-03  |  4.7 KB  |  131 lines
  1. ---- SUBMIT.DOC ----
  2.  
  3.         HOW TO MAKE A SUBMISSION TO THE ADA REPOSITORY ON SIMTEL20
  4.  
  5. OVERVIEW
  6.  
  7.         Please follow these steps:
  8.  
  9.         1.  Obtain the following files, via FTP or otherwise, from
  10.             the  PD:<ADA.GENERAL>  subdirectory   to   your   host
  11.             computer:
  12.     
  13.         SUBMIT.DOC -- latest submission instructions
  14.         PROLOGUE.ADA -- prologue for you to edit
  15.         SAMPLE.PRO -- a sample prologue
  16.     
  17.         2.  Read SUBMIT.DOC (this file).  This is the current  set
  18.             of submission instructions.
  19.  
  20.         3.  Edit PROLOGUE.ADA as per these instructions.
  21.  
  22.         4.  Name  the  edited PROLOGUE.ADA as something.PRO, where
  23.             "something" is  indicative  of  the  submission.   All
  24.             files  associated  with  a submission should contain a
  25.             maximum of thirteen characters (a nine-character name,
  26.             a   period,   and   a   three-character  suffix,  like
  27.             MYFILE.TXT).  The first six characters must be unique,
  28.             and  the  first  two  or three characters of all files
  29.             should be the  same  so  that  they  will  be  grouped
  30.             together  when  displayed  by the online documentation
  31.             system.  Only letters and digits may be used  in  file
  32.             names,  and  the  first  character  must  be a letter.
  33.             Consult  with  the  maintainer  of  the  Ada  Software
  34.             Repository  before  naming  your files so that you can
  35.             pick a 2-3 char prefix that is  different  from  those
  36.             already selected.
  37.  
  38.             Examples of good file names:
  39.     
  40.         MYFILE.TXT    SOMETHING.DOC    ED12.D    ED.
  41.         DOCUMENT.P01
  42.  
  43.         Examples of invalid file names:
  44.  
  45.         MY_FILE.TXT    -- contains a char other than letter
  46.                     or digit
  47.         THISISATEST.DOC    -- too long
  48.  
  49.         EDITOR.DOC
  50.         EDITOR1.DOC    -- grouped together, first six
  51.                     chars are not unique
  52.  
  53.        Example of a good submission:
  54.  
  55.         PP.PRO        -- PROLOGUE file
  56.         PP.SRC        -- PAGER source file containing
  57.                     all source code
  58.         PP.DOC        -- documentation file
  59.         PPREAD.ME    -- read me file
  60.  
  61.        Why this is good:
  62.         1) all file names are valid
  63.         2) all file names begin with the same first 2 or 3
  64.             characters (a command like DIR PP*.* will
  65.             pick them up)
  66.  
  67.     
  68.        5.  Transmit  all  files  to  SIMTEL20.   Consult  with  the
  69.            maintainer of the Ada Software  Repository.   There  are
  70.            several ways to transmit the files (tape, FTP, email).
  71.  
  72.  
  73. INSTRUCTIONS FOR EDITING PROLOGUE.ADA
  74.  
  75.         1.  UNIT  NAME:   Type in the name of the compilation unit
  76.             or system.  Use any format you desire.
  77.  
  78.         2.  VERSION:   Enter  a  version  number in any format you
  79.             desire.
  80.  
  81.         3.  AUTHOR:  Enter your name.  Your mailing address, phone
  82.             number, etc, are also acceptable.
  83.  
  84.         4.  DDN   ADDRESS:   Enter  your  DDN  electronic  mailing
  85.             address.
  86.  
  87.         5.  COPYRIGHT:  Enter a copyright entry.  SAMPLE.PRO shows
  88.             a  good   example,   and   the   files   COPYRITE.TXT,
  89.             COPYRITE.INF,  and  COPYRITE.DOC  in  PD:<ADA.GENERAL>
  90.             discuss  copyrights  in  some  detail.   If  you   are
  91.             releasing the software to the Public Domain, copyright
  92.             protection is  not  available  by  law.   Only  public
  93.             domain  software  is  accepted  in  the  Ada  Software
  94.             Repository.
  95.  
  96.         6.  DATE CREATED:  Please enter.
  97.  
  98.         7.  RELEASE DATE:  Please enter.
  99.  
  100.         8.  LAST  UPDATE:   Please  enter  in the following format
  101.             (see SAMPLE.PRO):
  102.     
  103.         NAME_OF_PERSON_MAKING_UPDATE   DATE
  104.     
  105.         9.  MACHINE/SYSTEM  COMPILED/RUN  ON:   Please  enter  the
  106.             computer which the software was compiled on and  state
  107.             what   Ada  compiler  was  used.   If  you  foresee  a
  108.             transportability problem due to machine  dependencies,
  109.             please state so here.
  110.  
  111.         10.  KEYWORDS:  Please  enter  some  keywords  or  phrases
  112.              which may be used to categorize your submission.
  113.  
  114.         11.  ABSTRACT:   Please  summarize  the  function  of  the
  115.              software.
  116.  
  117.         12.  REVISION HISTORY:  Please make an  "Initial  Release"
  118.              entry here.  See SAMPLE.PRO for an example.
  119.  
  120.         13.  DISTRIBUTION AND COPYRIGHT:  Edit this  as  per  your
  121.              wishes.    In  particular,  mark  the  Public  Domain
  122.              release statement as "is" or "is not".  Also add  any
  123.              restrictions,  such as "for non-commercial use only",
  124.              as you desire.
  125.  
  126.  
  127. THANK YOU
  128.  
  129.         Thank you for your submission to the Ada  Software  Repository
  130. at SIMTEL20.
  131.