/soundex

Indexing algorithm for names based on American English phonetics.

Primary LanguageC++MIT LicenseMIT

Soundex

Indexing algorithm for words based on American English phonetics. More information can be found on Wikipedia.

Build Status

Build Status

How to Build

After you pull down the repo run these commans to build and test the library:

mkdir build
cd build
cmake ..
make

Build artifacts are placed in the /build/bin and /build/lib folders.

Documenation

Doxygen can be run by typing the following after running cmake:

make docs

Docs will then be build to /build/docs.