=================================================================== RCS file: /home/cvs/OpenXM/src/asir-contrib/guideline.txt,v retrieving revision 1.5 retrieving revision 1.8 diff -u -p -r1.5 -r1.8 --- OpenXM/src/asir-contrib/guideline.txt 2005/03/24 09:09:34 1.5 +++ OpenXM/src/asir-contrib/guideline.txt 2005/03/26 23:25:46 1.8 @@ -1,23 +1,26 @@ -$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] 1. The name of your source code should be yourname_xyz.rr + if xyz is a general name like matrix, prime, resultant, etc. The part "yourname" may be your nickname. 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. 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 - naka_mora.rr + Your may use both your own directory and the top level source code + to load sources in the own directory. + Example: asir-contrib/packages/src/naka_mora + 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 + 2. Please encapsulate your source code with modules. + When you use the module name which represents a mathematical notion or a data structure, the module name should be pxxxx @@ -29,20 +32,26 @@ 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). + to use "oxweave & gentexi" or "gdoc" (see http://texinfo.org). 5. Please refer to papers that explain algorithms in your package 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. + 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 Windows: