From ec46a594dff3453c1091b01d4904f1ab1947d60d Mon Sep 17 00:00:00 2001 From: Kane York Date: Thu, 23 Jul 2020 14:49:20 -0700 Subject: docs(3p/nix): Document fast build by disabling clang-tidy Change-Id: I5a3a4a4013c35a3a377ad0b6068a1a40bf6d77e6 Reviewed-on: https://cl.tvl.fyi/c/depot/+/1386 Reviewed-by: glittershark Tested-by: BuildkiteCI --- third_party/nix/README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) 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. -- cgit 1.4.1