summaryrefslogtreecommitdiff
path: root/textproc/enchant/DESCR
diff options
context:
space:
mode:
Diffstat (limited to 'textproc/enchant/DESCR')
-rw-r--r--textproc/enchant/DESCR23
1 files changed, 23 insertions, 0 deletions
diff --git a/textproc/enchant/DESCR b/textproc/enchant/DESCR
new file mode 100644
index 00000000000..07228d4b0da
--- /dev/null
+++ b/textproc/enchant/DESCR
@@ -0,0 +1,23 @@
+The project aims to provide an efficient extensible abstraction
+for dealing with different spell checking libraries.
+
+Enchant is meant to provide a generic interface into various existing
+spell checking libaries. These include, but are not limited to:
+ * Aspell/Pspell
+ * Ispell
+ * Hspell
+ * Uspell
+
+Enchant is also meant to be used in a cross-platform (XP) environment.
+Part of this means that Enchant wants to limit its number of external
+dependencies to 0, or as close is as humanly possible. Also, any
+enchant consumer (i.e. a Word Processor) should not need to know
+about what backend providers Enchant knows about. In fact, Enchant
+shouldn't even need to know this information itself. To accomplish
+this, all of Enchant's providers are DLLs.
+
+Enchant is also meant to be used in a multi-user environment, such
+as Unix. It is preferable to have both a $USER and a $GLOBAL
+location for both provider DLLs and for dictionaries themselves,
+when possible. Enchant's DLL location algorithm takes this into
+account, and gives preference to the $USER DLLs, when found.