42 lines
1.7 KiB
Markdown
42 lines
1.7 KiB
Markdown
|
# go-farm
|
||
|
|
|
||
|
|
*Google's FarmHash hash functions implemented in Go*
|
||
|
|
|
||
|
|
[](https://github.com/dgryski/go-farm/tree/master)
|
||
|
|
[](https://travis-ci.org/dgryski/go-farm?branch=master)
|
||
|
|
[](https://coveralls.io/github/dgryski/go-farm?branch=master)
|
||
|
|
[](https://goreportcard.com/report/github.com/dgryski/go-farm)
|
||
|
|
[](http://godoc.org/github.com/dgryski/go-farm)
|
||
|
|
|
||
|
|
## Description
|
||
|
|
|
||
|
|
FarmHash, a family of hash functions.
|
||
|
|
|
||
|
|
This is a (mechanical) translation of the non-SSE4/non-AESNI hash functions from Google's FarmHash (https://github.com/google/farmhash).
|
||
|
|
|
||
|
|
|
||
|
|
FarmHash provides hash functions for strings and other data.
|
||
|
|
The functions mix the input bits thoroughly but are not suitable for cryptography.
|
||
|
|
|
||
|
|
All members of the FarmHash family were designed with heavy reliance on previous work by Jyrki Alakuijala, Austin Appleby, Bob Jenkins, and others.
|
||
|
|
|
||
|
|
For more information please consult https://github.com/google/farmhash
|
||
|
|
|
||
|
|
|
||
|
|
## Getting started
|
||
|
|
|
||
|
|
This application is written in Go language, please refer to the guides in https://golang.org for getting started.
|
||
|
|
|
||
|
|
This project include a Makefile that allows you to test and build the project with simple commands.
|
||
|
|
To see all available options:
|
||
|
|
```bash
|
||
|
|
make help
|
||
|
|
```
|
||
|
|
|
||
|
|
## Running all tests
|
||
|
|
|
||
|
|
Before committing the code, please check if it passes all tests using
|
||
|
|
```bash
|
||
|
|
make qa
|
||
|
|
```
|