| version 1.5, 2005/03/24 09:09:34 |
version 1.8, 2005/03/26 23:25:46 |
|
|
| $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.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. |
| Or, 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. |
| Example: todo_parametrize |
Example: asir-contrib/packages/src/todo_parametrize |
| |
|
| Your may use both your own directory and the top level source code. |
Your may use both your own directory and the top level source code |
| Example: naka_mora |
to load sources in the own directory. |
| naka_mora.rr |
Example: asir-contrib/packages/src/naka_mora |
| |
asir-contrib/packages/src/naka_mora.rr |
| |
|
| 2. Please encapsulate your source code with module. |
2. Please encapsulate your source code with modules. |
| 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, |
or a data structure, |
| the module name should be |
the module name should be |
| pxxxx |
pxxxx |
| Line 29 How to commit your asir program to asir-contrib? [2005 |
|
| Line 32 How to commit your asir program to asir-contrib? [2005 |
|
| |
|
| |
|
| 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: |
![[BACK]](/icons/cvsweb/back.gif){kind=icon}
Return to guideline.txt CVS log ![[TXT]](/icons/cvsweb/text.gif){kind=icon}
![[DIR]](/icons/cvsweb/dir.gif){kind=icon}
Up to [local] / OpenXM / src / asir-contrib