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 <grfn@gws.fyi>
Tested-by: BuildkiteCI
This commit is contained in:
Kane York 2020-07-23 14:49:20 -07:00 committed by kanepyork
parent b8e94002d6
commit ec46a594df

View file

@ -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.