diff --git a/README b/README deleted file mode 100644 --- a/README +++ /dev/null @@ -1,40 +0,0 @@ -Spelling word suggestion tool -Copyright © 2010 Bart Massey and Greg Weber -ALL RIGHTS RESERVED - -This software is licensed under the "3-clause ('new') -BSD License". Please see the file COPYING provided with -this distribution for license terms. - -This package is a newer version of the original package called "thimk". - -"thimk" (an old joke) is a command-line spelling word -suggestion tool. You give it a possibly-misspelled word, -and it spits out one or more properly-spelled words in order -of likelihood of similarity. - -The idea and name for thimk came from an old program that used to hang -around Reed College, probably written by Graham Ross and -now apparently lost in the mists of time. -See -for the one very vague reference I've found on the web (in the -SEE ALSO section of the referenced manpage). - -The current implementation is a bit more sophisticated -than I recall the original being. By -default it uses a prefilter that discards words with -large edit distances from the target, then filters words -with a different phonetic code than the target, then -presents the top result sorted by edit distance. - -The Soundex and Phonix phonetic codes are designed for -names, but seem to work about the same with other words. -I follow the common practice of not truncating the codes -for greater precision, although Phonix does truncate its -final "sound" for greater recall. - -The latest change to the implementation is an addition -of an optional precompiled SQlite database of phonetic -codes for the entire dictionary, created with -"thimk-makedb". This greatly speeds lookup, permitting -reasonable performance on enormous dictionaries. diff --git a/README.md b/README.md new file mode 100644 --- /dev/null +++ b/README.md @@ -0,0 +1,64 @@ +# Thimk and spelling-suggest +Spelling word suggestion tool and library +Copyright © 2010 Bart Massey and Greg Weber + +This software is licensed under the "3-clause ('new') +BSD License". Please see the file COPYING provided with +this distribution for license terms. + +This package is a newer version of the original package called "thimk". + +"thimk" (an old joke) is a command-line spelling word +suggestion tool. You give it a possibly-misspelled word, +and it spits out one or more properly-spelled words in order +of likelihood of similarity. + +Thimk is structured as a command-line interface to its +`spelling-suggest` library, originally split out by Greg +Weber. You can use this library for other applications +also. There is sufficient Haddock to work out how to use +it. It is packaged on Hackage as `spelling-suggest`. + +There is little documentation of the thimk command as-of +yet, but the usage message from the program should tell +everything needed to get started with it. + +The idea and name for thimk came from an old program that +used to hang around Reed College, probably written by Graham +Ross and now apparently lost in the mists of time. See this +[Usenet +post](http://groups.google.com/group/net.sources/msg/8856593862fe22bd) +for the one very vague reference I've found on the web (in +the SEE ALSO section of the referenced manpage). I +originally re-implemented thimk in [Nickle](http://nickle.org) some years ago, +but that implementation has been slow, clunky, and +non-portable. + +The current implementation is a bit more sophisticated +than I recall the original being. By +default it uses a prefilter that discards words with +large edit distances from the target, then filters words +with a different phonetic code than the target, then +presents the top result sorted by edit distance. + +The Soundex and Phonix phonetic codes are designed for +names, but seem to work about the same with other words. +I follow the common practice of not truncating the codes +for greater precision, although Phonix does truncate its +final "sound" for greater recall. + +The latest change to the implementation is an addition +of an optional precompiled SQlite database of phonetic +codes for the entire dictionary, created with +"thimk-makedb". This greatly speeds lookup, permitting +reasonable performance on enormous dictionaries. + +Building thimk and spelling-suggest requires my `parseargs` +and `phonetic-code` packages from hackage, as well as +`edit-distance` and +[sqlite-0.5.1](http://hackage.haskell.org/cgi-bin/hackage-scripts/package/sqlite) +or newer if you want to build and use the optional phonetic +codes database. It is probably easiest to build using cabal-install, +which should take care of most everything for you. + +--Bart Massey 2012-08-26 diff --git a/spelling-suggest.cabal b/spelling-suggest.cabal --- a/spelling-suggest.cabal +++ b/spelling-suggest.cabal @@ -1,15 +1,15 @@ name: spelling-suggest -version: 0.5.2.0 -cabal-version: >= 1.2 +version: 0.5.2.1 +cabal-version: >= 1.6 build-type: Simple license: BSD3 license-file: COPYING copyright: Copyright © 2010 Bart Massey and Greg Weber author: Bart Massey and Greg Weber maintainer: bart@cs.pdx.edu, greg@gregweber.info -homepage: http://wiki.cs.pdx.edu/bartforge/thimk +homepage: https://github.com/gregwebs/haskell-spell-suggest category: Console, Text -data-files: README, README.pcdb +data-files: README.md, README.pcdb synopsis: Spelling suggestion tool with library and command-line interfaces. description: @@ -58,3 +58,12 @@ ghc-options: -Wall if flag(debug) cpp-options: -DDEBUG + +Source-repository head + type: git + location: git://github.com/gregwebs/haskell-spell-suggest.git + +Source-repository this + type: git + location: git://github.com/gregwebs/haskell-spell-suggest.git + tag: v0.5.2.1