diff --git a/snix/eval/README.md b/snix/eval/README.md index 032e2c1db..8be18178c 100644 --- a/snix/eval/README.md +++ b/snix/eval/README.md @@ -1,9 +1,9 @@ -Tvix Evaluator +Snix Evaluator ============== This project implements an interpreter for the Nix programming language. You can experiment with an online version of the evaluator: -[tvixbolt][]. +[snixbolt][]. The interpreter aims to be compatible with `nixpkgs`, on the foundation of Nix 2.3. @@ -12,28 +12,9 @@ foundation of Nix 2.3. while the core mechanisms (compiler, runtime, ...) have stabilised somewhat, a lot of components are still changing rapidly. -Please contact [TVL](https://tvl.fyi) with any questions you might -have. - -## Building tvix-eval - -Please check the `README.md` one level up for instructions on how to build this. - -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: - -```bash -git clone https://code.tvl.fyi/depot.git:/tvix/eval.git tvix-eval - -cd tvix-eval && cargo build -``` - ## Tests -Tvix currently has three language test suites for tvix-eval: +Snix currently has three language test suites for snix-eval: * `nix_tests` and `snix_tests` are based on the same mechanism borrowed from the C++ Nix implementation. They consist of @@ -43,11 +24,11 @@ Tvix currently has three language test suites for tvix-eval: `eval-fail` (fails to evaluate, no expected output), `parse-okay` (expression parses successfully, no expected output) and `parse-fail` (expression fails to parse, no expected output). - Tvix currently ignores the last two types of test cases, since + Snix currently ignores the last two types of test cases, since it doesn't implement its own parser. Both test suites have a `notyetpassing` directory. All test cases - in here test behavior that is not yet supported by Tvix. They are + in here test behavior that is not yet supported by Snix. They are considered to be expected failures, so you can't forget to move them into the test suite proper when fixing the incompatibility. @@ -63,17 +44,17 @@ Tvix currently has three language test suites for tvix-eval: directories. The `notyetpassing` directory shows how far it is until we pass it completely. - * `snix_tests` contains test cases written by the Tvix contributors. + * `snix_tests` contains test cases written by the Snix contributors. Some more or less duplicate test cases contained in `nix_tests`, but many cover relevant behavior that isn't by `nix_tests`. Consequently, it'd be nice to eventually merge the two test suites into a jointly maintained, common Nix language test suite. It also has a `notyetpassing` directory for missing behavior - that is discovered while working on Tvix and isn't covered by the + that is discovered while working on Snix and isn't covered by the `nix_tests` suite. -* `nix_oracle` can evaluate Nix expressions in Tvix and compare the +* `nix_oracle` can evaluate Nix expressions in Snix and compare the result against C++ Nix (2.3) directly. Eventually it should gain the ability to property test generated Nix expressions. An additional feature is that it can evaluate expressions without @@ -81,12 +62,12 @@ Tvix currently has three language test suites for tvix-eval: ## rnix-parser -Tvix is written in memory of jD91mZM2, the author of [rnix-parser][] +Snix is written in memory of jD91mZM2, the author of [rnix-parser][] who sadly [passed away][rip]. -Tvix makes heavy use of rnix-parser in its bytecode compiler. The +Snix makes heavy use of rnix-parser in its bytecode compiler. The parser is now maintained by Nix community members. [rnix-parser]: https://github.com/nix-community/rnix-parser [rip]: https://www.redox-os.org/news/open-source-mental-health/ -[tvixbolt]: https://bolt.tvix.dev/ +[snixbolt]: https://bolt.snix.dev/ diff --git a/snix/eval/src/tests/snix_tests/README.md b/snix/eval/src/tests/snix_tests/README.md index b493aa81f..adcbe3f3b 100644 --- a/snix/eval/src/tests/snix_tests/README.md +++ b/snix/eval/src/tests/snix_tests/README.md @@ -1,4 +1,4 @@ -These tests are "native" to Tvix and exist in addition to the Nix test +These tests are "native" to Snix and exist in addition to the Nix test suite. All of these are straightforward code snippets which are expected to