Return to guideline.txt CVS log

Up to [local] / OpenXM / src / asir-contrib

Annotation of OpenXM/src/asir-contrib/guideline.txt, Revision 1.4

1.4     ! takayama    1: $OpenXM: OpenXM/src/asir-contrib/guideline.txt,v 1.3 2000/03/23 11:54:07 takayama Exp $
1.1       takayama    2:
1.4     ! takayama    3: How to commit your asir program to asir-contrib? [2005, 3/24]
        !             4:
        !             5:    1.  The name of your source code should be
        !             6:             yourname_xyz.rr
        !             7:        The part "yourname" may be your nickname.
        !             8:        Example:  noro_matrix.rr
1.1       takayama    9:
                     10:        Your asir source should be at asir-contrib/packages/src.
1.4     ! takayama   11:        You may make a new directory under asir-contrib/packages/src
        !            12:        to put your programs and data,
        !            13:        but the top level file must be under asir-contrib/packages/src.
        !            14:
        !            15:    2.  Please encapsulate your source code
        !            16:        If you want to use the module name which represents a mathematical notion
        !            17:        or a data structure,
        !            18:        the module name should be
        !            19:            pxxxx
        !            20:        where "p" is your identifying prefix and xxxx is a name of mathematical
        !            21:        notion or data structure name related to your module.
        !            22:        Example: nmatrix  where "p" is "n" and "xxxx" is "matrix".
        !            23:        Example: fres  where "p" is "f" and "xxxx" is "res" (or "resultant").
        !            24:
1.1       takayama   25:
1.4     ! takayama   26:    3.  Manuals should be written by the texinfo in English and/or Japanese.
        !            27:        They are put in asir-contrib/packagers/doc/'yourname_xyz'
        !            28:        The Makefile asir-contrib/packagers/doc/'yourname_xyz'/Makefile
        !            29:        is also necessary.
        !            30:        Example: asir-contrib/packages/doc/todo_parametrize/Makefile
        !            31:
        !            32:    4. If you want to embed your manual in the source, you are welcome
        !            33:       to use "oxweave" or "gdoc" (see http://texinfo.org).
        !            34:
        !            35:    5. Please refer to papers that explain algorithms in your package
        !            36:       from your texinfo manual.
        !            37:
        !            38:    6. Please include test data that you used to check the correctness
        !            39:       of your implementation.
        !            40:
        !            41:
        !            42:  Directory structure
        !            43:  Windows:
        !            44:      bin/
        !            45:      lib/
        !            46:      lib-asir-contrib/
        !            47:
        !            48:  Unix:
        !            49:     lib/asir
        !            50:     lib/asir-contrib
        !            51:
        !            52:  Documents (unix):
        !            53:    Online manual (ja)
        !            54:     lib/asir/help-jp/
        !            55:     lib/asir/help-jp/'modulename.functionname'
        !            56:
        !            57:    HTML manual (ja)
        !            58:     doc/asir-contrib/help-ja/cman-ja_toc.html
        !            59:     doc/asir-contrib/help-ja/'yourname_xyz'/'yourname_xyz'_ja_toc.html