Skip to content
This repository has been archived by the owner on Jan 23, 2020. It is now read-only.

Commit

Permalink
Writing "kthxbye" in Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Andreas Haller committed Nov 12, 2010
1 parent 8ca7c74 commit 1024728
Showing 1 changed file with 17 additions and 7 deletions.
24 changes: 17 additions & 7 deletions README.rdoc
@@ -1,9 +1,14 @@
= hunspell-ffi = hunspell-ffi


A Ruby FFI interface to the Hunspell spelling checker A Ruby FFI interface to the Hunspell spelling checker.

"Hunspell is the spell checker of OpenOffice.org and Mozilla Firefox 3 & Thunderbird, Google Chrome, and it is also used by proprietary softwares, like Mac OS X, memoQ, Opera and SDL Trados."
- http://hunspell.sourceforge.net/


It should work wherever Ruby FFI works (tested on Ruby 1.9.2, 1.8.7, JRuby 1.5.1). It should work wherever Ruby FFI works (tested on Ruby 1.9.2, 1.8.7, JRuby 1.5.1).


This should be a drop-in replacement for rhunspell (https://github.com/tiendung/rhunspell), but using ffi.

== Installation == Installation
=== Install Hunspell === Install Hunspell
On Mac OS X: Hunspell (libhunspell) is already installed on OSX 10.6. On Mac OS X: Hunspell (libhunspell) is already installed on OSX 10.6.
Expand All @@ -26,14 +31,19 @@ On Debian:
dict.add("Geburtstagskuchen") dict.add("Geburtstagskuchen")
dict.remove("Fichte") dict.remove("Fichte")


== Author == Authors
Andreas Haller Andreas Haller - https://github.com/ahaller
andreashaller@gmail.com


== License == License
Hereby placed under public domain, do what you want, just do not hold me accountable... Hereby placed under public domain, do what you want, just do not hold me accountable.

== Help wanted
I hear Hunspell has some superpowers like stemming and some that i never even heard of.
Maybe you want to help out to bring something of that power into the ruby world.
Or maybe we can think of a nice way to find to locate .dict files on a system or something.
Anyways, feel free to fork and send pull requests. kthxbye. Andreas.


== TODO === TODOs
Add hunspell analyzing methods (analyze, stem ...) Figure out how to use and add hunspell analyzing methods (analyze, stem ...)


Test on Windows Test on Windows

0 comments on commit 1024728

Please sign in to comment.