OpenXM/src/asir-contrib/guideline.txt - diff

Return to guideline.txt CVS log

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

version 1.5, 2005/03/24 09:09:34

version 1.6, 2005/03/24 22:07:15

Line 1

$OpenXM: OpenXM/src/asir-contrib/guideline.txt,v 1.4 2005/03/24 09:05:05 takayama Exp $

$OpenXM: OpenXM/src/asir-contrib/guideline.txt,v 1.5 2005/03/24 09:09:34 takayama Exp $

How to commit your asir program to asir-contrib? [2005, 3/24]

Line 10 How to commit your asir program to asir-contrib? [2005

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

Example: asir-contrib/packages/src/todo_parametrize

Your may use both your own directory and the top level source code.

Example: naka_mora

Example: asir-contrib/packages/src/naka_mora

naka_mora.rr

asir-contrib/packages/src/naka_mora.rr

2. Please encapsulate your source code with module.

If you want to use the module name which represents a mathematical notion

When you use the module name which represents a mathematical notion

or a data structure,

the module name should be

pxxxx

Line 29 How to commit your asir program to asir-contrib? [2005

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

is also necessary.

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

to use "oxweave" or "gdoc" (see http://texinfo.org).

Line 41 How to commit your asir program to asir-contrib? [2005

Line 43 How to commit your asir program to asir-contrib? [2005

from your texinfo manual.

6. Please include test data that you used to check the correctness

of your implementation.

of your implementation or to make demonstrations.

Directory structure