diff options
| -rw-r--r-- | third_party/nix/README.md | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/third_party/nix/README.md b/third_party/nix/README.md index 0d3c739d71f5..9e3d7486c87a 100644 --- a/third_party/nix/README.md +++ b/third_party/nix/README.md @@ -135,6 +135,22 @@ To set expectations, there are some explicit non-goals, too. Once we have OCI-compatible sandboxes and a store protocol it will be possible to reintroduce these with less friction. +## Building + +To build the project, set up an out-of-tree cmake directory and run cmake in +nix-shell. + +``` +mkdir ~/build/tvix +cd ~/build/tvix + +nix-shell $DEPOT_PATH -A third_party.nix + +# Disable clang-tidy for quicker builds +cmake $DEPOT_PATH -DCLANG_TIDY_PATH="" +make -j16 -l12 +``` + ## Contributing to the fork The TVL depot's default [contribution guidelines][contributing] apply. |