mdebray/tvl-depot
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs(tvix): move most of //tvix/eval README up to //tvix

Browse source 
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>
This commit is contained in:
Florian Klink 2023-01-21 12:37:54 +01:00 committed by clbot
parent 90979d39f3
commit 758b94f47c
2 changed files with 20 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
tvix/README.md
View file

@ -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 brainstorm and describe requirements that we may not yet have
considered. 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 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 management on the Nix side of these builds, we use `crate2nix` in a

15
tvix/eval/README.md
View file

@ -15,19 +15,12 @@ somewhat, a lot of components are still changing rapidly.
Please contact [TVL](https://tvl.fyi) with any questions you might Please contact [TVL](https://tvl.fyi) with any questions you might
have. have.
## Building the evaluator ## Building tvix-eval
If you are in a full checkout of the TVL depot, you can simply run `mg Please check the `README.md` one level up for instructions on how to build this.
build` in this directory (or `mg build //tvix/eval` 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 The evaluator itself can also be built with standard Rust tooling (i.e. `cargo
against Nix 2.3. There are a variety of bugs and subtle problems in build`).
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`).
If you would like to clone **only** the evaluator and build it If you would like to clone **only** the evaluator and build it
directly with Rust tooling, you can do: directly with Rust tooling, you can do: