maurice/snix
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs(tvix): document more components

Browse source 
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>
This commit is contained in:
Florian Klink 2024-11-10 10:36:10 +01:00 • committed by flokli
parent 9d114bf040
commit ef3a51b38d
1 changed files with 6 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

6
tvix/README.md
View file

@ -58,13 +58,19 @@ the tooling and communication methods outlined above.
This folder contains the following components: 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/castore` - subtree storage/transfer in a content-addressed fashion
* `//tvix/cli` - preliminary REPL & CLI implementation for Tvix * `//tvix/cli` - preliminary REPL & CLI implementation for Tvix
* `//tvix/docs` - standalone documentation
* `//tvix/eval` - an implementation of the Nix programming language * `//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/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-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/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/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 Some additional folders with auxiliary things exist and can be explored at your
leisure. leisure.