From 97c52f3666b1213145e8d00ae73ceae1f345ab99 Mon Sep 17 00:00:00 2001
From: dockes <none@none>
Date: Mon, 7 Nov 2005 15:37:06 +0000
Subject: [PATCH] *** empty log message ***

---
 src/README | 55 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 55 insertions(+)

diff --git a/src/README b/src/README
index 8e3f2c08..de9d87c0 100644
--- a/src/README
+++ b/src/README
@@ -2,6 +2,61 @@
 A more complete version of this document can be found at http://www.recoll.org
 
 
+     * Home
+     * Screenshots
+     * Credits
+     * Downloads
+     * Installation
+     * User manual
+   [IMG]
+
+Recoll
+
+   Recoll is a personal full text search package for Linux, FreeBSD and other
+   Unix systems.
+
+   Recoll is based on a very strong backend (Xapian), for which it provides
+   an easy to use, feature-rich, easy-administration interface.
+
+   Recoll is free and copyrighted under the GPL license, see COPYING inside
+   the distribution. A lot of the code is imported from other packages, see
+   the Credits.
+
+  Features:
+
+     * Document types: text, html, pdf (with pdftotext), postscript (with
+       ghostscript's pstotext), msword (with antiword), openoffice files,
+       maildir and mailbox mail folders (Mozilla and thunderbird mail ok).
+       Deals with compressed versions of same.
+     * Relatively powerful query facilities, with boolean searches, phrases,
+       filter on file types and directory tree.
+     * Support for multiple charsets. Internal processing and storage uses
+       Unicode UTF-8.
+     * Stemming performed at query time (can switch stemming language after
+       indexing)
+     * Easy installation. No database daemon, web server or exotic language
+       necessary. The idea is that everybody should index their files because
+       it makes life easier.
+     * GUI based on qt, written with qt Designer.
+     * An indexer which runs either as a thread inside the GUI or as an
+       external, cron'able program.
+
+   Recoll has been compiled and tested on FreeBSD, Linux, Darwin and Solaris
+   (versions FreeBSD 5.3, Redhat 7.3, Solaris 8, but other not too distant
+   releases should be ok too). You can download the source code here.
+
+  Things lacking, coming in the not too far future:
+
+     * An interactive configuration tool. You need to edit files by hand for
+       now.
+     * Packages, rpm or other. It's all tar files currently.
+     * Documentation and help.
+     * Translations for the user interface.
+     * A few more filters for less common file types.
+
+   I very much welcome suggestions or (gasp) code.
+
+   In hope that this can be useful to somebody, it already is for me.
      * Home
      * Screenshots
      * Credits