about summary refs log tree commit diff
diff options
context:
space:
mode:
authorFlorian Klink <flokli@flokli.de>2024-11-10T09·36+0100
committerflokli <flokli@flokli.de>2024-11-12T09·42+0000
commitef3a51b38dd8653b4930ae6b0185210e3f123838 (patch)
tree93e9b294ddd87e987ab8e5ca244e8933c940d5cd
parent9d114bf040b92b87196d0621aef00188f801265f (diff)
docs(tvix): document more components r/8909
Change-Id: I0e75445a34d3ee11e535e6948c6d762f4fb15105
Reviewed-on: https://cl.tvl.fyi/c/depot/+/12760
Autosubmit: flokli <flokli@flokli.de>
Tested-by: BuildkiteCI
Reviewed-by: Domen Kožar <domen@cachix.org>
Reviewed-by: flokli <flokli@flokli.de>
-rw-r--r--tvix/README.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/tvix/README.md b/tvix/README.md
index af12d6ff4b10..8f2a719012b3 100644
--- a/tvix/README.md
+++ b/tvix/README.md
@@ -58,13 +58,19 @@ the tooling and communication methods outlined above.
 
 This folder contains the following components:
 
+* `//tvix/boot` - tooling to boot MicroVMs off of `tvix-[ca]store`
+* `//tvix/build` - a generic (Nix-unaware) builder protocol and various implementations
 * `//tvix/castore` - subtree storage/transfer in a content-addressed fashion
 * `//tvix/cli` - preliminary REPL & CLI implementation for Tvix
+* `//tvix/docs` - standalone documentation
 * `//tvix/eval` - an implementation of the Nix programming language
+* `//tvix/glue` - combines tvix-eval with tvix-[ca]store and tvix-build, implementation of build- and import-related builtins
 * `//tvix/nar-bridge` - a HTTP webserver providing a Nix HTTP Binary Cache interface in front of a tvix-store
 * `//tvix/nix-compat` - a Rust library for compatibility with C++ Nix, features like encodings and hashing schemes and formats
+* `//tvix/nix-daemon` - a Nix-compatible store daemon backed by Tvix
 * `//tvix/serde` - a Rust library for using the Nix language for app configuration
 * `//tvix/store` - a "filesystem" linking Nix store paths and metadata with the content-addressed layer
+* `//tvix/tracing` - unified library to configure logging, tracing, instrumentation and progress concerns
 
 Some additional folders with auxiliary things exist and can be explored at your
 leisure.