Skip to content

Commit

Permalink
Updates to Timelord.md
Browse files Browse the repository at this point in the history
  • Loading branch information
hoffmang9 authored and wjblanke committed Jun 1, 2020
1 parent fc89144 commit 2405aa6
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 11 deletions.
27 changes: 27 additions & 0 deletions BUILD_TIMELORD.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
The Linux and MacOS chiavdf binary wheels currently exclude an executable
required to run a Timelord. If you want to run a Timelord on Linux or MacOS,
you must install the wheel from source (which may require some additional
development packages) while in the virtual environment.

```
. ./activate
sh install-timelord.sh
```

If the compile fails, it's likely due to a missing dependency.
[install-timelord.sh](https://github.com/Chia-Network/chia-blockchain/blob/master/install-timelord.sh)
attempts to install required build dependencies for Linux and MacOS before
invoking pip to build from the source python distribution of chiavdf.

The `install-timelord.sh` install script leverages two environmental variables
that the chiavdf wheels can use to specify how to build. `vdf_client` is the
service that the Timelord uses to run the VDF and prove the Proof of Time.
`vdf_bench` is a utility to get a sense of a given CPU's iterations per second.

- To build vdf_client set the environment variable BUILD_VDF_CLIENT to "Y".
`export BUILD_VDF_CLIENT=Y`.
- Similarly, to build vdf_bench set the environment variable BUILD_VDF_BENCH
to "Y". `export BUILD_VDF_BENCH=Y`.

Building and running Timelords in Windows x86-64 is not yet supported.
11 changes: 0 additions & 11 deletions LINUX_TIMELORD.md

This file was deleted.

0 comments on commit 2405aa6

Please sign in to comment.