Updated some documentation.

git-svn-id: http://svn.cactuscode.org/arrangements/CactusBase/IOBasic/trunk@108 b589c3ab-70e8-4b4d-a09f-cba2dd200880

1 files changed, 17 insertions, 9 deletions

diff --git a/README b/README
index 3ec9d6d..cbc872b 100644
--- a/README
+++ b/README
@@ -1,23 +1,31 @@
-Cactus Code Thorn IOScalar
+Cactus Code Thorn IOBasic
 Authors    : Gabrielle Allen
 CVS info   : $Header$
 --------------------------------------------------------------------------
 
 1. Purpose of the thorn
 
-This thorn outputs grid variables as scalars as a function on time
+This thorn provides two I/O methods "Info" and "Scalar" which output grid
+variables as scalars as a function on time.
 
-Scalars:
-Output straight forwardly
+Grid scalars:
+ - Output the value of the scalar straight forwardly
 
 Grid functions:
-Output the minimum, maximum, L1, and L2 norm versus time.
+ - Output the reduction value of the grid function versus time.
+   For this you also need to activate a thorn which implements reduction
+   operators (eg. PUGHReduce which provides the standard reductions
+   "minimum", "maximum", "sum", "norm1", "norm2", and "norm_inf").
 
-Ouput files can be processed with either gnuplot or xgraph.
 
-The IO method "IOScalar" is registered which can be called 
-by other thorns via CCTK_OutputVarAsByMethod() to output a 
-variable without specifying it in the parameter file.
+The "Info" method would print the values, along with the current iteration
+number and the physical time, in a formatted table to stdout.
+
+The "Scalar" methods outputs to ASCII files which can be processed with
+gnuplot or xgraph.
 
 
 2. Additional information
+
+There is more comprehensive documention available in this thorn's
+doc/documentation.tex file which is included in the Cactus Thorn Guide.