about summary refs log tree commit diff
path: root/tvix/README.md
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/README.md
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/README.md')
-rw-r--r--tvix/README.md17
1 files changed, 16 insertions, 1 deletions
diff --git a/tvix/README.md b/tvix/README.md
index e06b59bef9e7..a00032b9126b 100644
--- a/tvix/README.md
+++ b/tvix/README.md
@@ -6,7 +6,22 @@ are interested in people who would like to help us review designs,
 brainstorm and describe requirements that we may not yet have
 considered.
 
-## Rust projects
+## Building the CLI
+
+If you are in a full checkout of the TVL depot, you can simply run `mg build`
+in the `cli` directory (or `mg build //tvix/cli` from anywhere in the repo).
+The `mg` command is found in `/tools/magrathea`.
+
+**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 CLI can also be built with standard Rust tooling (i.e. `cargo build`),
+as long as you are in a shell with the right dependencies (provided by `mg
+shell //tvix:shell`).
+
+## Rust projects, crate2nix
 
 Some parts of Tvix are written in Rust. To simplify the dependency
 management on the Nix side of these builds, we use `crate2nix` in a