<commit_before>Copyright 2006 <NAME> <<EMAIL>>
7/13/2006

** Introduction

Montezuma is a text search engine library for Lisp based on the Ferret
library[1] for Ruby, which is itself based on the Lucene library[2]
for Java.

[1] http://ferret.davebalmain.com/trac
[2] http://lucene.apache.org/


** Requirements

Montezuma has been tested with SBCL 0.9.12 (OS X/PPC), SBCL 0.9.13
(Linux/x86) OpenMCL 1.0 (OS X/PPC) and ACL 8.0 (OS X/PPC).

Montezuma requires the CL-PPCRE[1] and CL-FAD[2] libraries.

The only implementation-dependent code in Montezuma is in
src/util/mop.lisp.  To add support for another implementation may be
as simple as adding one line to the definition of the CLASS-SLOTS
function and one to SLOT-DEFINITION-NAME.

[1] http://www.cliki.net/CL-PPCRE
[2] http://www.cliki.net/CL-FAD


** Installation and Loading

You can use ASDF-INSTALL to install Montezuma:

  (asdf-install:install '#:montezuma)

And ASDF to load it:

  (asdf:oos 'asdf:load-op '#:montezuma)


** Testing

Once Montezuma has been loaded, you can run the unit tests if you
like:

  (asdf:oos 'asdf:test-op '#:montezuma)


** Use

See the TUTORIAL.TXT file for more information on how to use
Montezuma.

The Montezuma project page at http://projects.heavymeta.org/montezuma/
should have the latest information about Montezuma.


** Acknowledgements

Thanks to <NAME>, <NAME> and <NAME>.
<commit_msg>Fleshed out the acknowledgements a bit.<commit_after>Copyright 2006 <NAME> <<EMAIL>>
7/13/2006

** Introduction

Montezuma is a text search engine library for Lisp based on the Ferret
library[1] for Ruby, which is itself based on the Lucene library[2]
for Java.

[1] http://ferret.davebalmain.com/trac
[2] http://lucene.apache.org/


** Requirements

Montezuma has been tested with SBCL 0.9.12 (OS X/PPC), SBCL 0.9.13
(Linux/x86) OpenMCL 1.0 (OS X/PPC) and ACL 8.0 (OS X/PPC).

Montezuma requires the CL-PPCRE[1] and CL-FAD[2] libraries.

The only implementation-dependent code in Montezuma is in
src/util/mop.lisp.  To add support for another implementation may be
as simple as adding one line to the definition of the CLASS-SLOTS
function and one to SLOT-DEFINITION-NAME.

[1] http://www.cliki.net/CL-PPCRE
[2] http://www.cliki.net/CL-FAD


** Installation and Loading

You can use ASDF-INSTALL to install Montezuma:

  (asdf-install:install '#:montezuma)

And ASDF to load it:

  (asdf:oos 'asdf:load-op '#:montezuma)


** Testing

Once Montezuma has been loaded, you can run the unit tests if you
like:

  (asdf:oos 'asdf:test-op '#:montezuma)


** Use

See the TUTORIAL.TXT file for more information on how to use
Montezuma.

The Montezuma project page at http://projects.heavymeta.org/montezuma/
should have the latest information about Montezuma.


** Acknowledgements

Thanks to <NAME>, <NAME>, <NAME> (for his META-inspired
parser), <NAME> (for the heap implementation from his TIMER
library[1]) and Franz. Inc. (for their Porter stemmer[2]).

[2] http://www.xach.com/lisp/timer/doc.html
[3] http://www.lispwire.com/entry-text-porter-word-stemmer-des

{'fraction_non_alphanumeric': 0.11023622047244094, 'fraction_numerical': 0.022965879265091863, 'mean_word_length': 4.0647840531561465, 'pattern_counts': {'":': 0, '<': 16, '<?xml version=': 0, '>': 16, 'https://': 0, 'lorem ipsum': 0, 'www.': 6, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '727820', 'n_tokens_mistral': 1174, 'n_tokens_neox': 1090, 'n_words': 376}