r22928 - /trunk/sample_scripts/README -- May 02, 2014 - 14:28

Author: bugman
Date: Fri May  2 14:28:53 2014
New Revision: 22928

URL: http://svn.gna.org/viewcvs/relax?rev=22928&view=rev
Log:
Added a README file to the sample_scripts directory to help users understand 
what these scripts are for.

It also explains how these scripts should be used.


Added:
    trunk/sample_scripts/README

Added: trunk/sample_scripts/README
URL: 
http://svn.gna.org/viewcvs/relax/trunk/sample_scripts/README?rev=22928&view=auto
==============================================================================
--- trunk/sample_scripts/README (added)
+++ trunk/sample_scripts/README Fri May  2 14:28:53 2014
@@ -0,0 +1,8 @@
+The relax sample scripts are designed to help you create your own scripts to 
perform your own custom analyses.  The correct way to use these scripts are 
as follows:
+
+    - Find the script which is closest to the analysis you wish to perform.
+    - Copy that script to your own analysis directory.
+    - Modify the file paths to point to your own files.
+    - Customise the settings and user function calls to suit your data.
+
+Note, you should never run these scripts directly from the sample_script/ 
directories.  A few of the scripts will run without modification using data 
from the relax test suite directories, however the majority will not.  They 
are not provided as a tutorial but as a starting example to be modified to 
suit your needs.