# declaration of what to build (hint: nodist only seems to apply to SOURCES)
bin_PROGRAMS = zet zet_trec zet_cat zet_impactify
-# Nick has changed data_ to pkgdata_
-pkgdata_DATA = config/psettings.xml
+# Nick has changed data_ to pkgdata_ and added some useful information/data
+pkgdata_DATA = config/README config/psettings.xml txt/moby.txt
lib_LTLIBRARIES = libzet.la
noinst_PROGRAMS = zet_diff zet_file zet_dict \
src/test/str_1 \
# doc/Readme.html \
# doc/README.TXT
-EXTRA_DIST = config/psettings.xml config/stoplist_sorted \
+EXTRA_DIST = config/README config/psettings.xml config/stoplist_sorted \
txt/moby.txt txt/README \
src/compat/win32_stubs.c \
src/compat/zglob.c doc/Build.html doc/Content.html \
--- /dev/null
+SAMPLE CONFIGURATION FILE
+
+The file /usr/share/zettair/psettings.xml contains lists of ML tags and
+how they are to be processed by zettair when creating an index from ML
+documents. It can be sent to the indexing process with the -c option:
+ zet -i -c /usr/share/zettair/psettings.xml file1.html ...
+
+There is a section for each type of ML document that can be processed,
+identified by MIME type: text/html for HTML documents, application/x-trec
+for TREC documents and so on. In each section there is a list of tags,
+and for each tag there is a flag for whether the contents of the tag
+should be index, and for whether text can flow through the tag (otherwise
+the tag ends the current sentence that is being processed).
+
+Changing the file in /usr/share/zettair has no effect since the library
+libzet.so.* contains compiled-in settings (the same as those in this
+example file) to use when no configuration file is provided. The file in
+/usr/share/zettair is provided as a starting point for your modifications.
+
+SAMPLE DOCUMENT FILE
+
+The file /usr/share/zettair/moby.txt is given as an example of a document
+collection in TREC format. There are individual documents in it formatted
+like <DOC><DOCNO>...</DOCNO>...</DOC>. You can build an index as follows:
+ zet -i /usr/share/zettair/moby.txt
+This will produce a set of files index* in the current directory. The
+default "index" prefix can be changed by using the -f option, for example:
+ zet -i -f myindex /usr/share/zettair/moby.txt
+
+The index can then be searched by running one of the following commands:
+ zet
+ zet -f myindex
+This gives an interactive interface where you can type your queries and
+see results. Search terms are highlighted in results by capitalization.