Skip to content

Latest commit

 

History

History
35 lines (21 loc) · 1.58 KB

README.md

File metadata and controls

35 lines (21 loc) · 1.58 KB
Raw

Nimfuzzy is a Nim wrapper for the fts_fuzzy_match library by Forrest Smith.

Nimfuzzy is distributed as a Nimble package and depends on nimgen and c2nim to generate the wrappers. The fts_fuzzy_match.h source code is downloaded using curl/powershell.

Installation

Nimfuzzy can be installed via Nimble:

> nimble install https://github.com/genotrance/nimfuzzy

This will download, wrap and install nimfuzzy in the standard Nimble package location, typically ~/.nimble. Once installed, it can be imported into any Nim program.

Usage

Module documentation can be found here.

import nimfuzzy/fts_fuzzy_match

var i: cint = 0
echo fuzzy_match("ftw", "ForrestTheWoods", i)
echo i

Credits

Nimfuzzy wraps the fts_fuzzy_match.h library and all its licensing terms apply to the usage of this package.

Credits go out to c2nim as well without which this package would be greatly limited in its abilities.

Feedback

Nimfuzzy is a work in progress and any feedback or suggestions are welcome. It is hosted on GitHub with an MIT license so issues, forks and PRs are most appreciated.