Skip to content

Latest commit

 

History

History
36 lines (21 loc) · 1.34 KB

README.md

File metadata and controls

36 lines (21 loc) · 1.34 KB

meow

meow is a Nim wrapper for the meow_hash library.

meow is distributed as a Nimble package and depends on nimterop to generate the wrappers. The meow_hash source code is downloaded using Git so having git in the path is required.

Installation

meow can be installed via Nimble:

> nimble install meow

This will download and install meow 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 meow

echo MeowFile("path/to/file")

Credits

meow wraps the meow_hash source code and all licensing terms of meow_hash apply to the usage of this package.

Feedback

meow 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.

Documentation

See the documentation for the meow module as generated directly from the source.