[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.4 and 1.8

version 1.4, 2005/03/24 09:05:05 version 1.8, 2005/03/26 23:25:46
Line 1 
Line 1 
 $OpenXM: OpenXM/src/asir-contrib/guideline.txt,v 1.3 2000/03/23 11:54:07 takayama Exp $  $OpenXM: OpenXM/src/asir-contrib/guideline.txt,v 1.7 2005/03/24 23:41:16 takayama Exp $
   
 How to commit your asir program to asir-contrib? [2005, 3/24]  How to commit your asir program to asir-contrib? [2005, 3/24]
   
    1.  The name of your source code should be     1.  The name of your source code should be
             yourname_xyz.rr              yourname_xyz.rr
          if xyz is a general name like matrix, prime, resultant, etc.
        The part "yourname" may be your nickname.         The part "yourname" may be your nickname.
        Example:  noro_matrix.rr         Example:  noro_matrix.rr
          If xyz is not a general name, the part yourname_ is not necessary.
   
        Your asir source should be at asir-contrib/packages/src.         Your asir source should be at asir-contrib/packages/src.
        You may make a new directory under asir-contrib/packages/src         Or, you may make a new directory under asir-contrib/packages/src
        to put your programs and data,         to put your programs and data.
        but the top level file must be under asir-contrib/packages/src.         Example: asir-contrib/packages/src/todo_parametrize
   
    2.  Please encapsulate your source code         Your may use both your own directory and the top level source code
        If you want to use the module name which represents a mathematical notion         to load sources in the own directory.
          Example:  asir-contrib/packages/src/naka_mora
                    asir-contrib/packages/src/naka_mora.rr
   
      2.  Please encapsulate your source code with modules.
          When you use the module name which represents a mathematical notion
        or a data structure,         or a data structure,
        the module name should be         the module name should be
            pxxxx             pxxxx
Line 21  How to commit your asir program to asir-contrib? [2005
Line 28  How to commit your asir program to asir-contrib? [2005
        notion or data structure name related to your module.         notion or data structure name related to your module.
        Example: nmatrix  where "p" is "n" and "xxxx" is "matrix".         Example: nmatrix  where "p" is "n" and "xxxx" is "matrix".
        Example: fres  where "p" is "f" and "xxxx" is "res" (or "resultant").         Example: fres  where "p" is "f" and "xxxx" is "res" (or "resultant").
          Example: nmora  where "p" is "n" and "xxxx" is "mora".
   
   
    3.  Manuals should be written by the texinfo in English and/or Japanese.     3.  Manuals should be written by the texinfo in English and/or Japanese.
        They are put in asir-contrib/packagers/doc/'yourname_xyz'         They are put under the directory
          asir-contrib/packagers/doc/'yourname_xyz'
        The Makefile asir-contrib/packagers/doc/'yourname_xyz'/Makefile         The Makefile asir-contrib/packagers/doc/'yourname_xyz'/Makefile
        is also necessary.         is also necessary.
        Example: asir-contrib/packages/doc/todo_parametrize/Makefile         Example: asir-contrib/packages/doc/todo_parametrize/Makefile
             asir-contrib/packages/doc/todo_parametrize/todo_parametrize_ja.texi
   
    4. If you want to embed your manual in the source, you are welcome     4. If you want to embed your manual in the source, you are welcome
       to use "oxweave" or "gdoc" (see http://texinfo.org).        to use "oxweave & gentexi" or "gdoc" (see http://texinfo.org).
   
    5. Please refer to papers that explain algorithms in your package     5. Please refer to papers that explain algorithms in your package
       from your texinfo manual.        from your texinfo manual.
   
    6. Please include test data that you used to check the correctness     6. Please include test data that you used to check the correctness
       of your implementation.        of your implementation or to make demonstrations.
   
      7. About function names of your module.
        Please use any names you like.
        However, please also include "long function names" separated by "_"
        such as  "total_degree".
   
  Directory structure   Directory structure
  Windows:   Windows:
Legend:
Removed from v.1.4  
changed lines
  Added in v.1.8
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>