Corrected the format according to the documentation
[infodrom/dtaus] / README
diff --git a/README b/README
index 999a548..d900ecf 100644 (file)
--- a/README
+++ b/README
@@ -1,61 +1,57 @@
 $Id$
 
-This package contains a library that can read and write german DTAUS
-files.  DTAUS is an acronym for DatenTrägerAUStausch.  It is used by
-credit institutes in order to transfer commands for money exchange
-between accounts.
+This package contains one executable that is able to read and write
+DTAUS files that are commonly used in Germany.  DTAUS is an acronym
+for DatenTrägerAUStausch.  It is used by credit institutes in order to
+transfer commands for money exchanges between bank accounts.
 
 DTAUS files use a special but simple and freely documented format.
 I've attached a written down version in dtaus.txt in this
 distribution.
 
 As DTAUS uses very long integer values you can't rely on regular C
-integer variables.  Therefore I've written a small library that acts
-on big integer numbers.  At the moment it only contains routines that
-are needed by dtaus but you're invited to improve it and send back
-appropriate patches to me.  The library is called bigint and can be
-found at ftp://ftp.infodrom.north.de/pub/clib/math/bigint-0.1.tar.gz
+long integer variables.  Therefore this package includes a small (and
+incomplete) library that deals with large integer numbers.  At the
+moment it only contains routines that are needed by dtaus but you're
+invited to improve it and send back appropriate patches to me.  The
+library is called bigint and is included in this package.
 
-You need to extract it into the same directory where the dtaus files
-are.  After that just run make and you should get an executable named
-dtaus.
-
-Supported Currency
-------------------
-
-At the moment the only currency supported is DM.  There are some hooks
-for supporting the new european currency Euro but it is not yet
-implemented.
-
-What needs to be done:
+More Information
+----------------
 
- . Simple support for Euro in record A
- . When writing records C and E, divert the field for amount
- . Ignore specified currency for record C
- . Reading dtaus, simple support for currency field
- . When reading dtaus, divert the field for amount
+I have set up a couple of web pages describing the dtaus package as
+well as collecting additional information that may be useful to dtaus
+users.  Please check out:
 
-Additional Info
----------------
+  <http://www.infodrom.org/projects/dtaus/>
 
-The A record (the first one in the .ctl file) needs to contain one
-"Art foo" field.  This field may contain one of the following, only
-the two-letter code within the double quotes.
+There is a mailing list set up on lists.infodrom.org that deals with
+DTAUS and appropriate issues.  If you have questions or suggestions
+please subscribe to the list and post there.
 
-    "LB" für Lastschriften Bankseitig
-    "LK" für Lastschriften Kundenseitig
-    "GB" für Gutschriften Bankseitig
-    "GK" für Gutschriften Kundenseitig
+The source code for this package is also available through anonymous
+CVS at :pserver:anonymous@cvs.infodrom.org:/var/cvs/infodrom using the
+module dtaus.  Accessing this is described in detail at the web pages
+mentioned above.
 
-More Information
-----------------
+Please don't contact me personally if you don't have confidential
+questions or information.  Please use the mailing list from above
+instead.  Using the mailing list has a couple of advantages.  Your
+question and comments are archived publically and properly so they can
+be used later as well.  As another bonus somebody else than me could
+answer a question, hence not incrementing my workload and it's more
+difficult to forget about it.
 
-  Web: http://www.infodrom.north.de/dtaus/
+The submission address for the mailing list is:
 
-  Mail: dtaus@infodrom.north.de (Majordomo and SmartList driven)
+  infodrom-dtaus@lists.infodrom.org
 
+To subscribe, send a mail to majordomo@lists.infodrom.org with the
+body "subscribe infodrom dtaus" -- or send a mail to SmartList at
+infodrom-dtaus-request@lists.infodrom.org with the subject
+"subscribe".
 
 Good luck!
 
                                                Martin Schulze
-                                          <joey@infodrom.north.de>
+                                          <joey@infodrom.org>