--- a/src/README
+++ b/src/README
@@ -1,7 +1,8 @@
+ * Home
* Screenshots
* Downloads
* Credits
- * User guide
+ * User manual
* Installation
[IMG]
@@ -24,10 +25,10 @@
Features:
- * Supports the following document types: text, html, pdf (with xpdf's
- 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.
+ * Document types: text, html, pdf (with xpdf's 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
@@ -47,8 +48,6 @@
Things lacking, coming in the not too far future:
- * A better GUI. So many things are badly done or missing that I won't
- try to list them here.
* An interactive configuration tool. You need to edit files by hand for
now.
* Packages, rpm or other. It's all tar files currently.
@@ -56,64 +55,11 @@
* Documentation and help.
* A few more filters for less common file types.
- Using recoll
-
- * Use File->Index to build/rebuild the database (what to index is
- defined in the configuration file, see the install doc).
- * Enter search terms in the upper left text field. There is no query
- language right now, the search only understand probabilistic terms
- (just words...), and double-quote enclosed phrases. Click Search or
- type CR
- * A result list should appear in the left pane. You can use the
- Next/Prev buttons to paginate.
- * Clicking on an entry in the list will display a preview in the right
- pane -- This can take some time for big postscript or pdf files, as
- the file is converted on the fly for preview --
- * Double-clicking on an entry should launch an external viewer, as
- specified in the mimeconf file (see INSTALL). This doesn't work for
- compressed files for now.
-
I very much welcome suggestions or (gasp) code
In hope that this can be useful to somebody, it already is for me.
- Downloads
-
- Current version: 1.0 (tar.gz)
-
- Older: 0.7
-
- Installation
-
- Prerequisites
-
- At the very least, you will need to download and install the xapian core
- package (I am currently using xapian version 0.8.5), and the qt runtime
- and development packages (I am currently using qt 3.3.3).
-
- You will most probably be able to find a binary package for qt for your
- system. You may have to compile xapian, but this is not difficult.
-
- You also need libiconv. I am currently using version 1.9. The iconv
- interface is part of libc on Linux systems, you shouldn't need to do
- anything there.
-
- External file types: recoll uses external applications to index some file
- types. You need to install them for the file types that you wish to have
- indexed:
-
- * MS Word documents: antiword.
- * PDF files: pdftotext is part of the Xpdf package.
- * Postscript files: pstotext.
-
- Compiling, installing, using
-
- See the INSTALL file.
-
Credits
-
- Recoll is mainly glue code, and most of the intelligent parts use code
- from external projects.
Recoll borrows (steals?) heavily from the following projects. I tried to
include the relevant copyright attributions with the code. Any omission is