summaryrefslogtreecommitdiff
path: root/shared/c-siphash/README.md
blob: ba09041be46079ce95873ec899bb6a118db3af4b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
c-siphash
=========

Streaming-capable SipHash Implementation

The c-siphash project is a standalone implementation of SipHash in Standard
ISO-C11. It provides a streaming-capable API to compute data hashes according
to the SipHash algorithm. For API documentation, see the c-siphash.h header
file, as well as the docbook comments for each function.

### Project

 * **Website**: <https://c-util.github.io/c-siphash>
 * **Bug Tracker**: <https://github.com/c-util/c-siphash/issues>

### Requirements

The requirements for this project are:

 * `libc` (e.g., `glibc >= 2.16`)

At build-time, the following software is required:

 * `meson >= 0.41`
 * `pkg-config >= 0.29`

### Build

The meson build-system is used for this project. Contact upstream
documentation for detailed help. In most situations the following
commands are sufficient to build and install from source:

```sh
mkdir build
cd build
meson setup ..
ninja
meson test
ninja install
```

No custom configuration options are available.

### Repository:

 - **web**:   <https://github.com/c-util/c-siphash>
 - **https**: `https://github.com/c-util/c-siphash.git`
 - **ssh**:   `git@github.com:c-util/c-siphash.git`

### License:

 - **Apache-2.0** OR **LGPL-2.1-or-later**
 - See AUTHORS file for details.