[BACK]Return to guideline.txt CVS log [TXT][DIR] Up to [local] / OpenXM / src / asir-contrib

Diff for /OpenXM/src/asir-contrib/guideline.txt between version 1.1 and 1.5

version 1.1, 1999/12/23 03:59:06 version 1.5, 2005/03/24 09:09:34
Line 1 
Line 1 
 $OpenXM$  $OpenXM: OpenXM/src/asir-contrib/guideline.txt,v 1.4 2005/03/24 09:05:05 takayama Exp $
   
 How to commit your asir program to asir-contrib?  [1999, 12/23]  How to commit your asir program to asir-contrib? [2005, 3/24]
   
    1.  The function names and global variables     1.  The name of your source code should be
        should start with  xyz_  or Xyz_ where xyz is              yourname_xyz.rr
        the name of your package.         The part "yourname" may be your nickname.
        For example, all functions in the package "sm1" start with         Example:  noro_matrix.rr
        sm1_, e.g., there are functions sm1_gb, sm1_hilbert, and so on  
        in the package "sm1".  
        Your asir source should be at asir-contrib/packages/src.         Your asir source should be at asir-contrib/packages/src.
          Or, you may make a new directory under asir-contrib/packages/src
          to put your programs and data.
          Example: todo_parametrize
   
          Your may use both your own directory and the top level source code.
          Example:  naka_mora
                    naka_mora.rr
   
      2.  Please encapsulate your source code with module.
          If you want to use the module name which represents a mathematical notion
          or a data structure,
          the module name should be
              pxxxx
          where "p" is your identifying prefix and xxxx is a name of mathematical
          notion or data structure name related to your module.
          Example: nmatrix  where "p" is "n" and "xxxx" is "matrix".
          Example: fres  where "p" is "f" and "xxxx" is "res" (or "resultant").
          Example: nmora  where "p" is "n" and "xxxx" is "mora".
   
   
    2.  Manuals should be written by the texinfo in English.     3.  Manuals should be written by the texinfo in English and/or Japanese.
        They are put in asir-contrib/packagers/doc         They are put in asir-contrib/packagers/doc/'yourname_xyz'
        and are included from asir-contrib/packagers/doc/cman-eg.texi.         The Makefile asir-contrib/packagers/doc/'yourname_xyz'/Makefile
        Japanese committers are expected to write Japanese manuals, too.         is also necessary.
        Japanese manuals are included from         Example: asir-contrib/packages/doc/todo_parametrize/Makefile
        asir-contrib/packagers/doc/cman.texi.  
        As to styles of manuals, see files in asir-contrib/packagers/doc.  
   
      4. If you want to embed your manual in the source, you are welcome
         to use "oxweave" or "gdoc" (see http://texinfo.org).
   
   
   
      5. Please refer to papers that explain algorithms in your package
         from your texinfo manual.
   
      6. Please include test data that you used to check the correctness
         of your implementation.
   
   
    Directory structure
    Windows:
        bin/
        lib/
        lib-asir-contrib/
   
    Unix:
       lib/asir
       lib/asir-contrib
   
    Documents (unix):
      Online manual (ja)
       lib/asir/help-jp/
       lib/asir/help-jp/'modulename.functionname'
   
      HTML manual (ja)
       doc/asir-contrib/help-ja/cman-ja_toc.html
       doc/asir-contrib/help-ja/'yourname_xyz'/'yourname_xyz'_ja_toc.html
Legend:
Removed from v.1.1  
changed lines
  Added in v.1.5
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>