From 6015604bd81e064da8253c58825315a3b8e47b30 Mon Sep 17 00:00:00 2001 From: Florian Klink Date: Sun, 24 Sep 2023 22:28:09 +0300 Subject: [PATCH] docs(tvix) sync readme and website component listing, extend These existed with slightly similar descriptions in both places, and castore and nar-bridge and castore were missing entirely. Change-Id: I4794c18665e25ee1f812975b526ff27ce197d0af Reviewed-on: https://cl.tvl.fyi/c/depot/+/9453 Reviewed-by: Connor Brewster Tested-by: BuildkiteCI Autosubmit: flokli --- tvix/README.md | 10 ++++++---- tvix/website/landing-en.md | 10 ++++++---- 2 files changed, 12 insertions(+), 8 deletions(-) diff --git a/tvix/README.md b/tvix/README.md index 42659336e..bc154030d 100644 --- a/tvix/README.md +++ b/tvix/README.md @@ -46,11 +46,13 @@ the tooling and communication methods outlined above. This folder contains the following components: -* `//tvix/eval` - an implementation of the Nix programming language -* `//tvix/nix-compat` - library functions for compatibility with C++ Nix +* `//tvix/castore` - subtree storage/transfer in a content-addressed fashion * `//tvix/cli` - preliminary REPL & CLI implementation for Tvix -* `//tvix/serde` - Rust library for using the Nix language for app configuration -* `//tvix/store` - implementation of a file store for Tvix +* `//tvix/eval` - an implementation of the Nix programming language +* `//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/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 Some additional folders with auxiliary things exist and can be explored at your leisure. diff --git a/tvix/website/landing-en.md b/tvix/website/landing-en.md index b6419b634..4537fc7f2 100644 --- a/tvix/website/landing-en.md +++ b/tvix/website/landing-en.md @@ -12,11 +12,13 @@ Tvix is developed as a GPLv3-licensed open-source project by There are several projects within Tvix, such as: +* `//tvix/castore` - subtree storage/transfer in a content-addressed fashion +* `//tvix/cli` - preliminary REPL & CLI implementation for Tvix * `//tvix/eval` - an implementation of the Nix programming language -* `//tvix/store` - filesystem subtree storage/transfer in a content-addressed fashion -* `//tvix/serde` - a Rust library for using the Nix language for config files -* `//tvix/nix-compat` - a Rust library for compatibility with C++ Nix - features like encodings and hashing schemes +* `//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/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 * ... and a handful others! The language evaluator can be toyed with in [Tvixbolt][], and you can check out