about summary refs log tree commit diff
path: root/tvix/eval
diff options
context:
space:
mode:
authorFlorian Klink <flokli@flokli.de>2023-01-21T11·37+0100
committerclbot <clbot@tvl.fyi>2023-01-21T15·08+0000
commit758b94f47cd53f2ce182e3bef6584d2230ab4e37 (patch)
tree0a8e954653409b98a4d01d449e44a7e49a85f578 /tvix/eval
parent90979d39f330d788f50528056a5180912973831b (diff)
docs(tvix): move most of //tvix/eval README up to //tvix r/5725
While moving the CLI out of the evaluator, we forgot to update the
README in //tvix/eval. Move this up to //tvix, so people know where
to start.

Keep the instructions on how to build only `//tvix/eval` in `//tvix/
eval/README.md`.

Change-Id: Ie2755e8b5a0056225dbf3a0ee040f70f7f6a1f27
Reviewed-on: https://cl.tvl.fyi/c/depot/+/7887
Reviewed-by: sterni <sternenseemann@systemli.org>
Autosubmit: flokli <flokli@flokli.de>
Tested-by: BuildkiteCI
Reviewed-by: tazjin <tazjin@tvl.su>
Diffstat (limited to 'tvix/eval')
-rw-r--r--tvix/eval/README.md15
1 files changed, 4 insertions, 11 deletions
diff --git a/tvix/eval/README.md b/tvix/eval/README.md
index 1f19ceb0e5ed..04bc6c3eb82b 100644
--- a/tvix/eval/README.md
+++ b/tvix/eval/README.md
@@ -15,19 +15,12 @@ somewhat, a lot of components are still changing rapidly.
 Please contact [TVL](https://tvl.fyi) with any questions you might
 have.
 
-## Building the evaluator
+## Building tvix-eval
 
-If you are in a full checkout of the TVL depot, you can simply run `mg
-build` in this directory (or `mg build //tvix/eval` from anywhere in
-the repo).  The `mg` command is found in `/tools/magrathea`.
+Please check the `README.md` one level up for instructions on how to build this.
 
-**Important note:** We only use and test Nix builds of our software
-against Nix 2.3. There are a variety of bugs and subtle problems in
-newer Nix versions which we do not have the bandwidth to address,
-builds in newer Nix versions may or may not work.
-
-The evaluator can also be built with standard Rust tooling (i.e.
-`cargo build`).
+The evaluator itself can also be built with standard Rust tooling (i.e. `cargo
+build`).
 
 If you would like to clone **only** the evaluator and build it
 directly with Rust tooling, you can do: