2018-02-15 12:59:33 -08:00
|
|
|
[![Build Status](https://travis-ci.org/garious/phist.svg?branch=master)](https://travis-ci.org/garious/phist)
|
2018-02-16 08:02:44 -08:00
|
|
|
[![codecov](https://codecov.io/gh/garious/phist/branch/master/graph/badge.svg)](https://codecov.io/gh/garious/phist)
|
2018-02-14 14:25:49 -08:00
|
|
|
|
2018-02-15 15:09:11 -08:00
|
|
|
# :punch: phist :punch:
|
2018-02-15 12:59:33 -08:00
|
|
|
|
|
|
|
An implementation of Loom's Proof-of-History.
|
2018-02-15 15:09:11 -08:00
|
|
|
|
|
|
|
|
|
|
|
# Developing
|
|
|
|
|
2018-02-16 09:38:12 -08:00
|
|
|
Building
|
|
|
|
---
|
|
|
|
|
|
|
|
Install rustc, cargo and rustfmt:
|
2018-02-15 15:09:11 -08:00
|
|
|
|
|
|
|
```bash
|
|
|
|
$ curl https://sh.rustup.rs -sSf | sh
|
2018-02-16 09:38:12 -08:00
|
|
|
$ source $HOME/.cargo/env
|
|
|
|
$ rustup component add rustfmt-preview
|
2018-02-15 15:09:11 -08:00
|
|
|
```
|
|
|
|
|
|
|
|
Download the source code:
|
|
|
|
|
|
|
|
```bash
|
|
|
|
$ git clone https://github.com/garious/phist.git
|
|
|
|
$ cd phist
|
|
|
|
```
|
|
|
|
|
2018-02-16 09:38:12 -08:00
|
|
|
Testing
|
|
|
|
---
|
|
|
|
|
2018-02-15 15:09:11 -08:00
|
|
|
Run the test suite:
|
|
|
|
|
|
|
|
```bash
|
|
|
|
cargo test
|
|
|
|
```
|
2018-02-16 09:38:12 -08:00
|
|
|
|
|
|
|
Benchmarking
|
|
|
|
---
|
|
|
|
|
|
|
|
First install the nightly build of rustc. `cargo bench` requires unstable features:
|
|
|
|
|
|
|
|
```bash
|
|
|
|
$ rustup install nightly
|
|
|
|
```
|
|
|
|
|
|
|
|
Run the benchmarks:
|
|
|
|
|
|
|
|
```bash
|
|
|
|
$ cargo +nightly bench --features="unstable"
|
|
|
|
```
|