about summary refs log tree commit diff
path: root/third_party/nix
diff options
context:
space:
mode:
authorKane York <kanepyork@gmail.com>2020-07-23T21·49-0700
committerkanepyork <rikingcoding@gmail.com>2020-07-23T21·58+0000
commitec46a594dff3453c1091b01d4904f1ab1947d60d (patch)
tree8d3568285711ba8f840d181ebeb99b7c28107105 /third_party/nix
parentb8e94002d6a0a416a3128e1bc275d73f59700321 (diff)
docs(3p/nix): Document fast build by disabling clang-tidy r/1436
Change-Id: I5a3a4a4013c35a3a377ad0b6068a1a40bf6d77e6
Reviewed-on: https://cl.tvl.fyi/c/depot/+/1386
Reviewed-by: glittershark <grfn@gws.fyi>
Tested-by: BuildkiteCI
Diffstat (limited to 'third_party/nix')
-rw-r--r--third_party/nix/README.md16
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.