From 15abc50fafd2ac89c37f49d0e7fb2facfb7b2b9a Mon Sep 17 00:00:00 2001 From: sjplimp <sjplimp@f3b2605a-c512-4ea7-a41b-209d697bcdaa> Date: Wed, 3 Oct 2007 17:37:29 +0000 Subject: [PATCH] git-svn-id: svn://svn.icms.temple.edu/lammps-ro/trunk@944 f3b2605a-c512-4ea7-a41b-209d697bcdaa --- doc/Section_modify.html | 26 ++++++++++++++++---------- doc/Section_modify.txt | 26 ++++++++++++++++---------- 2 files changed, 32 insertions(+), 20 deletions(-) diff --git a/doc/Section_modify.html b/doc/Section_modify.html index 49e70b95bd..978f897e0c 100644 --- a/doc/Section_modify.html +++ b/doc/Section_modify.html @@ -564,11 +564,11 @@ us. See existing package files for examples of these details. </P> <P>Your user package will be a directory with a name like USER-FOO. In addition to your new files, the directory should contain a README, -Install.csh and style_user_foo.h file. +Install.csh and style_user_foo.h file. Send us a tarball of this +USER-FOO directory. </P> <P>The README text file should contain your name and contact information -and a brief description of what your new package does. This is for -users to look at. +and a brief description of what your new package does. </P> <P>The Install.csh and style_user_foo.h files enable LAMMPS to include and exclude your package. @@ -580,13 +580,19 @@ necessary to implement the new features. They don't have to be written in the same style and syntax as other LAMMPS files, thought that would be nice. </P> -<P>Finally, you also need to send us a documentation file for each new -command or style you are adding to LAMMPS. These are text files which -we will convert to HTML. Use one of the *.txt files in the doc dir as -a starting point for the new file you create, since it should look -similar to the doc files for existing commands and styles. Note that -the more clear and self-exaplantory you make your documentation, the -more likely it is that users will try out your new feature. +<P>Finally, in addition to the USER-FOO tarball, you also need to send us +a documentation file for each new command or style you are adding to +LAMMPS. These are text files which we will convert to HTML. Use one +of the *.txt files in the doc dir as a starting point for the new file +you create, since it should look similar to the doc files for existing +commands and styles. The "Restrictions" section of the doc page +should indicate that your feature is only available if LAMMPS is built +with the "user-foo" package. See other user package files for an +example of how to do this. +</P> +<P>Note that the more clear and self-exaplantory you make your doc and +README files, the more likely it is that users will try out your new +feature. </P> <HR> diff --git a/doc/Section_modify.txt b/doc/Section_modify.txt index fe3f361271..c8e402e2b9 100644 --- a/doc/Section_modify.txt +++ b/doc/Section_modify.txt @@ -541,11 +541,11 @@ us. See existing package files for examples of these details. Your user package will be a directory with a name like USER-FOO. In addition to your new files, the directory should contain a README, -Install.csh and style_user_foo.h file. +Install.csh and style_user_foo.h file. Send us a tarball of this +USER-FOO directory. The README text file should contain your name and contact information -and a brief description of what your new package does. This is for -users to look at. +and a brief description of what your new package does. The Install.csh and style_user_foo.h files enable LAMMPS to include and exclude your package. @@ -557,13 +557,19 @@ necessary to implement the new features. They don't have to be written in the same style and syntax as other LAMMPS files, thought that would be nice. -Finally, you also need to send us a documentation file for each new -command or style you are adding to LAMMPS. These are text files which -we will convert to HTML. Use one of the *.txt files in the doc dir as -a starting point for the new file you create, since it should look -similar to the doc files for existing commands and styles. Note that -the more clear and self-exaplantory you make your documentation, the -more likely it is that users will try out your new feature. +Finally, in addition to the USER-FOO tarball, you also need to send us +a documentation file for each new command or style you are adding to +LAMMPS. These are text files which we will convert to HTML. Use one +of the *.txt files in the doc dir as a starting point for the new file +you create, since it should look similar to the doc files for existing +commands and styles. The "Restrictions" section of the doc page +should indicate that your feature is only available if LAMMPS is built +with the "user-foo" package. See other user package files for an +example of how to do this. + +Note that the more clear and self-exaplantory you make your doc and +README files, the more likely it is that users will try out your new +feature. :line :line -- GitLab