Return to guideline.txt CVS log

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

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

1.3     ! takayama    1: $OpenXM: OpenXM/src/asir-contrib/guideline.txt,v 1.2 2000/02/05 07:25:36 takayama Exp $
1.1       takayama    2:
                      3: How to commit your asir program to asir-contrib?  [1999, 12/23]
                      4:
                      5:    1.  The function names and global variables
                      6:        should start with  xyz_  or Xyz_ where xyz is
                      7:        the name of your package.
                      8:        For example, all functions in the package "sm1" start with
                      9:        sm1_, e.g., there are functions sm1_gb, sm1_hilbert, and so on
                     10:        in the package "sm1".
                     11:        Your asir source should be at asir-contrib/packages/src.
                     12:
                     13:    2.  Manuals should be written by the texinfo in English.
                     14:        They are put in asir-contrib/packagers/doc
                     15:        and are included from asir-contrib/packagers/doc/cman-eg.texi.
                     16:        Japanese committers are expected to write Japanese manuals, too.
                     17:        Japanese manuals are included from
                     18:        asir-contrib/packagers/doc/cman.texi.
1.2       takayama   19:        As to styles of manuals, see files in asir-contrib/packages/doc.
                     20:
                     21:     3. If you want to embed your manual in the source, you are welcome
                     22:        to use "oxweave".
1.1       takayama   23:
1.3     ! takayama   24:     4. Please refer to papers that explain algorithms in your package
        !            25:        from your texinfo manual.
        !            26:        Papers are welcome to be included in this asir-contrib package.
        !            27:        Put them under asir-contrib/packages/doc directory.
        !            28:
        !            29:
        !            30:     5. Please compare your implementation with other implementations.
        !            31:
        !            32:     6. Please include test data that you used to check the correctness
        !            33:        of your implementation.
1.1       takayama   34:
                     35: