document usage/status

#335
Opened by kiaragrouwstra at 2023-11-28T15·11+00

tvix sounds pretty cool. as such, as a user of nixos + home-manager, i would be interested to learn how to use it. however, currently the tvix readme leaves this topic undocumented, including questions such as:

  1. just realized the status questions seem largely answered in the second blog post

    kiaragrouwstra at 2023-11-28T15·18+00

  2. The second blog post is over a year out of date, we need to write a new one :)

    There are two more recent updates, but in talk form:

    We haven't focused much on user-facing documentation yet, as we have specific goals for first usage in mind which are not initially "somebody using Tvix as a drop-in for their personal NixOS machines (this probably answers you rsecond question), and most people using the codebase in some form are its developers. Definitely something we need to improve, though :)

    how do i install this?

    You can clone either our entire repo, and build the components you're interested in using nix-build (e.g. nix-build -A tvix.cli), or you can clone only the Tvix subtree (git clone https://code.tvl.fyi/depot.git:workspace=views/tvix.git) and build it with standard Rust tooling.


    I'll keep this ticket around for user-facing documentation improvements.

    tazjin at 2023-11-28T15·31+00