summaryrefslogtreecommitdiffstats
path: root/contrib/snowball/doc/libstemmer_java_README
diff options
context:
space:
mode:
authorVsevolod Stakhov <vsevolod@highsecure.ru>2015-12-31 17:38:02 +0000
committerVsevolod Stakhov <vsevolod@highsecure.ru>2015-12-31 17:38:02 +0000
commit2375dba898b481837879940dfdcf3ea85248fe01 (patch)
treecced5fb680e9a362d1de25630bff537865d38365 /contrib/snowball/doc/libstemmer_java_README
parent1543c98d38ffb84a1e405081436d0a25bee713a6 (diff)
downloadrspamd-2375dba898b481837879940dfdcf3ea85248fe01.tar.gz
rspamd-2375dba898b481837879940dfdcf3ea85248fe01.zip
Remove bloody submodules.
Diffstat (limited to 'contrib/snowball/doc/libstemmer_java_README')
-rw-r--r--contrib/snowball/doc/libstemmer_java_README40
1 files changed, 40 insertions, 0 deletions
diff --git a/contrib/snowball/doc/libstemmer_java_README b/contrib/snowball/doc/libstemmer_java_README
new file mode 100644
index 000000000..38b1af693
--- /dev/null
+++ b/contrib/snowball/doc/libstemmer_java_README
@@ -0,0 +1,40 @@
+libstemmer_java
+===============
+
+This document pertains to the Java version of the libstemmer distribution,
+available for download from:
+
+http://snowball.tartarus.org/dist/libstemmer_java.tgz
+
+
+Compiling the library
+=====================
+
+Simply run the java compiler on all the java source files under the java
+directory. For example, this can be done under unix by changing directory into
+the java directory, and running:
+
+ javac org/tartarus/snowball/*.java org/tartarus/snowball/ext/*.java
+
+This will compile the library and also an example program "TestApp" which
+provides a command line interface to the library.
+
+
+Using the library
+=================
+
+There is currently no formal documentation on the use of the Java version
+of the library. Additionally, its interface is not guaranteed to be
+stable.
+
+The best documentation of the library is the source of the TestApp example
+program.
+
+
+The TestApp example
+===================
+
+The TestApp example program allows you to run any of the stemmers
+compiled into the libstemmer library on a sample vocabulary. For
+details on how to use it, run it with no command line parameters.
+