docs(tvix/eval): Add initial evaluator README r/4399

Change-Id: I85df002dc13c91a184d064586244f6a7440320fb
Reviewed-on: https://cl.tvl.fyi/c/depot/+/6063
Tested-by: BuildkiteCI
Reviewed-by: grfn <grfn@gws.fyi>

1 files changed, 30 insertions, 0 deletions

diff --git a/tvix/eval/README.md b/tvix/eval/README.md
new file mode 100644
index 0000000000..8320aa8ea3
--- /dev/null
+++ b/tvix/eval/README.md
@@ -0,0 +1,30 @@
+Tvix Evaluator
+==============
+
+This project implements an interpreter for the Nix programming
+language.
+
+The interpreter aims to be compatible with `nixpkgs`, on the
+foundation of Nix 2.3.
+
+<!-- TODO(tazjin): Remove this note when appropriate -->
+Work on this project is *extremely in-progress*, and the state of the
+project in the public repository may not necessarily reflect the state
+of the private codebase, as we are slowly working on publishing it.
+
+We expect this to have caught up in a handful of weeks (as of
+2022-08-12).
+
+Please contact [TVL](https://tvl.fyi) with any questions you might
+have.
+
+## rnix-parser
+
+Tvix 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
+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/