Return to guideline.txt CVS log

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

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

1.7     ! takayama    1: $OpenXM: OpenXM/src/asir-contrib/guideline.txt,v 1.6 2005/03/24 22:07:15 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.5       takayama   11:        Or, you may make a new directory under asir-contrib/packages/src
                     12:        to put your programs and data.
1.6       takayama   13:        Example: asir-contrib/packages/src/todo_parametrize
1.4       takayama   14:
1.5       takayama   15:        Your may use both your own directory and the top level source code.
1.6       takayama   16:        Example:  asir-contrib/packages/src/naka_mora
                     17:                  asir-contrib/packages/src/naka_mora.rr
1.5       takayama   18:
                     19:    2.  Please encapsulate your source code with module.
1.6       takayama   20:        When you use the module name which represents a mathematical notion
1.4       takayama   21:        or a data structure,
                     22:        the module name should be
                     23:            pxxxx
                     24:        where "p" is your identifying prefix and xxxx is a name of mathematical
                     25:        notion or data structure name related to your module.
                     26:        Example: nmatrix  where "p" is "n" and "xxxx" is "matrix".
                     27:        Example: fres  where "p" is "f" and "xxxx" is "res" (or "resultant").
1.5       takayama   28:        Example: nmora  where "p" is "n" and "xxxx" is "mora".
1.4       takayama   29:
1.1       takayama   30:
1.4       takayama   31:    3.  Manuals should be written by the texinfo in English and/or Japanese.
1.6       takayama   32:        They are put under the directory
                     33:        asir-contrib/packagers/doc/'yourname_xyz'
1.4       takayama   34:        The Makefile asir-contrib/packagers/doc/'yourname_xyz'/Makefile
                     35:        is also necessary.
                     36:        Example: asir-contrib/packages/doc/todo_parametrize/Makefile
1.6       takayama   37:           asir-contrib/packages/doc/todo_parametrize/todo_parametrize_ja.texi
1.4       takayama   38:
                     39:    4. If you want to embed your manual in the source, you are welcome
                     40:       to use "oxweave" or "gdoc" (see http://texinfo.org).
                     41:
                     42:    5. Please refer to papers that explain algorithms in your package
                     43:       from your texinfo manual.
                     44:
                     45:    6. Please include test data that you used to check the correctness
1.6       takayama   46:       of your implementation or to make demonstrations.
1.4       takayama   47:
1.7     ! takayama   48:    7. About function names of your module.
        !            49:      Please use any names you like.
        !            50:      However, please also include "long function names" separated by "_"
        !            51:      such as  "total_degree".
1.4       takayama   52:
                     53:  Directory structure
                     54:  Windows:
                     55:      bin/
                     56:      lib/
                     57:      lib-asir-contrib/
                     58:
                     59:  Unix:
                     60:     lib/asir
                     61:     lib/asir-contrib
                     62:
                     63:  Documents (unix):
                     64:    Online manual (ja)
                     65:     lib/asir/help-jp/
                     66:     lib/asir/help-jp/'modulename.functionname'
                     67:
                     68:    HTML manual (ja)
                     69:     doc/asir-contrib/help-ja/cman-ja_toc.html
                     70:     doc/asir-contrib/help-ja/'yourname_xyz'/'yourname_xyz'_ja_toc.html