=================================================================== RCS file: /home/cvs/OpenXM/src/asir-contrib/guideline.txt,v retrieving revision 1.4 retrieving revision 1.6 diff -u -p -r1.4 -r1.6 --- OpenXM/src/asir-contrib/guideline.txt 2005/03/24 09:05:05 1.4 +++ OpenXM/src/asir-contrib/guideline.txt 2005/03/24 22:07:15 1.6 @@ -1,4 +1,4 @@ -$OpenXM: OpenXM/src/asir-contrib/guideline.txt,v 1.3 2000/03/23 11:54:07 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] @@ -8,12 +8,16 @@ How to commit your asir program to asir-contrib? [2005 Example: noro_matrix.rr Your asir source should be at asir-contrib/packages/src. - You may make a new directory under asir-contrib/packages/src - to put your programs and data, - but the top level file must be under asir-contrib/packages/src. + Or, you may make a new directory under asir-contrib/packages/src + to put your programs and data. + Example: asir-contrib/packages/src/todo_parametrize - 2. Please encapsulate your source code - If you want to use the module name which represents a mathematical notion + Your may use both your own directory and the top level source code. + Example: asir-contrib/packages/src/naka_mora + asir-contrib/packages/src/naka_mora.rr + + 2. Please encapsulate your source code with module. + When you use the module name which represents a mathematical notion or a data structure, the module name should be pxxxx @@ -21,13 +25,16 @@ How to commit your asir program to asir-contrib? [2005 notion or data structure name related to your module. Example: nmatrix where "p" is "n" and "xxxx" is "matrix". Example: fres where "p" is "f" and "xxxx" is "res" (or "resultant"). + Example: nmora where "p" is "n" and "xxxx" is "mora". 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). @@ -36,7 +43,7 @@ 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