#335030 thanks gpk: Clarify British/American in README
[project/porterstemmer.git] / INSTALL.txt
1 // $Id$
2
3 For general information about this module, check the README.txt file.
4
5 Installation
6 ------------
7
8 1. Unzip the files, and upload them as a subdirectory of the
9 sites/all/modules directory of your Drupal installation (or the
10 location you normally use for contributed modules).
11
12 2. Go to 'Administer > Modules', and enable the Porter Stemmer module.
13
14 3. Go to 'Administer > Configuration > Search and metadata > Search settings'
15 and click 'Re-index site'.  You should do this step whenever you upgrade to a
16 new version of the Porter Stemmer module, so that the search index is
17 rebuilt with any changes to the stemming algorithm.
18
19 4. Ensure that cron has run at least once, to build the search
20 index. On larger sites, it may take several cron runs to complete the
21 search index. You can check progress on the Search settings page, and
22 you can run cron manually by visiting 'Administer > Reports > Status report',
23 and clicking on 'Run cron manually'.
24
25 5. This module will use the PECL "stem" library for PHP, if it is installed
26 on your server. If you have full administrative/root access to your server, and
27 are comfortable with Apache/PHP configuration and system administration, you
28 can install this library by following the instructions at:
29   http://us3.php.net/manual/en/install.pecl.php
30 Once the library is installed, you will need to add a line to your php.ini
31 file to enable the module:
32   extension=stem.so
33 If the PECL "stem" library is not available, the module uses a PHP
34 implementation of the stemming algorithm. The output is identical.
35 More information about the PECL "stem" library:
36   http://pecl.php.net/package/stem