--- trunk/README 2004/08/28 14:37:13 13 +++ trunk/README 2004/08/28 15:19:22 14 @@ -1,16 +1,14 @@ -jsFind version 0.01 +jsFind version 0.03 =================== -The README is used to introduce the module and provide instructions on -how to install the module, any machine dependencies it may have (for -example C compilers and installed libraries) and any other information -that should be provided before the module is installed. - -A README file is required for CPAN modules since CPAN extracts the -README file from a module distribution so that people browsing the -archive can use it get an idea of the modules uses. It is usually a -good idea to provide version information here so that people can -decide whether fixes for the module are worth downloading. +This module can be used to create index files for jsFind, powerful tool +for adding a search engine to a CDROM archive or catalog without +requiring the user to install anything. + +Main difference between this module and scripts delivered with jsFind are: + +- You don't need to use swish-e to create index +- You can programatically (and incrementaly) create index for jsFind INSTALLATION @@ -25,16 +23,21 @@ This module requires these other modules and libraries: - blah blah blah + Carp + File::Path + HTML::Entities + Text::Iconv COPYRIGHT AND LICENCE -Put the correct copyright and licence information here. - Copyright (C) 2004 by Dobrica Pavlinusic -This library is free software; you can redistribute it and/or modify -it under the same terms as Perl itself, either Perl version 5.8.4 or, -at your option, any later version of Perl 5 you may have available. +This program is free software; you can redistribute it and/or modify it +under the terms of the GNU General Public License as published by the Free +Software Foundation; either version 2 of the License, or (at your option) +any later version. This program is distributed in the hope that it will be +useful, but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General +Public License for more details.