Document how to invoke the script(s)

1 files changed, 14 insertions, 0 deletions

diff --git a/README b/README
index 744b020..a05d0de 100644
--- a/README
+++ b/README
@@ -1,5 +1,19 @@
 This project can currently dump and (partially) normalize white pages from Deutsche Telekom's CD and DVDs.
 
+_=_=_=_=_=_=_=
+How to extract
+-=-=-=-=-=-=-=
+
+Whereever possible I tried to make everything to work just by typing "sh makecolumns.sh <path to white pages>", where the white pages is what usually comes on your CD as "white" directory. You will need a working C compiler and make, plus aroud 4 GB of hard disc space left for the results. All tools necessary will be built automatically by the shell script.
+
+The scripts also use a tiny helper tool called "el" that you will need to fetch, compile and copy into one of your PATH directories. Find it at https://erdgeist.org/arts/software/el, check out the sources with "git clone git://erdgeist.org/el" or "cvs -d :pserver:anoncvs@cvs.erdgeist.org:/home/cvsroot co el".
+
+The script will create a work/ directory and put a dump directory according to the name of your white page directory below that.
+
+_=_=_=_=_=_=_=_=_=_=_=_=_
+File format documentation
+-=-=-=-=-=-=-=-=-=-=-=-=-
+
 The on-disc-data currently comes in four flavours (see https://erdgeist.org/posts/2008/datenmessie.html)
 
 version 1) Teleauskunft 1188 from 1992, (April-June)