From e639af17751bc24fe9cb07f625e1965f68f23d6c Mon Sep 17 00:00:00 2001 From: Florian Klink Date: Mon, 24 Mar 2025 01:40:05 +0000 Subject: [PATCH] docs(snix): drop getting-started.md This has already been migrated to //web. Change-Id: I1a6e1cbe2866be9519928f77acfabc96988ccf25 Reviewed-on: https://cl.snix.dev/c/snix/+/30271 Tested-by: besadii Reviewed-by: Ryan Lahfa Autosubmit: Florian Klink --- snix/docs/src/SUMMARY.md | 3 -- snix/docs/src/getting-started.md | 59 -------------------------------- 2 files changed, 62 deletions(-) delete mode 100644 snix/docs/src/getting-started.md diff --git a/snix/docs/src/SUMMARY.md b/snix/docs/src/SUMMARY.md index ec012909e..40d44965e 100644 --- a/snix/docs/src/SUMMARY.md +++ b/snix/docs/src/SUMMARY.md @@ -1,8 +1,5 @@ # Summary -# Welcome -* [Getting Started](./getting-started.md) - # Tvix - [Architecture & data flow](./architecture.md) - [TODOs](./TODO.md) diff --git a/snix/docs/src/getting-started.md b/snix/docs/src/getting-started.md deleted file mode 100644 index a427c906c..000000000 --- a/snix/docs/src/getting-started.md +++ /dev/null @@ -1,59 +0,0 @@ -# Getting Started - -## Getting the code, a developer shell, & building the CLI - -Tvix can be built with the Rust standard `cargo build`. A Nix shell is provided -with the correctly-versioned tooling to build. - -### TVL monorepo - -```console -$ git clone https://code.tvl.fyi/depot.git -$ cd depot -``` - -[Direnv][] is highly recommended in order to enable [`mg`][mg], a tool for -workflows in monorepos. Follow the [Direnv installation -instructions][direnv-inst], then after it’s set up continue with: - -```console -$ direnv allow -$ mg shell //snix:shell -$ cd tvix -$ cargo build -``` - -### Or just Tvix - -At present, this option isn’t suitable for contributions & lacks the tooling of -the monorepo, but still provides a `shell.nix` which can be used for building -the Tvix project. - -```console -$ git clone https://code.tvl.fyi/depot.git:workspace=views/tvix.git -$ cd tvix -$ nix-shell -$ cargo build -``` - - -# Builds & tests - -All projects are built using [Nix][] to avoid ‘build pollution’ via the user’s -local environment. - -If you have Nix installed and are contributing to a project tracked in this -repository, you can usually build the project by calling `nix-build -A -path.to.project`. - -For example, to build a project located at `//tools/foo` you would call -`nix-build -A tools.foo` - -If the project has tests, check that they still work before submitting your -change. - - -[Direnv]: https://direnv.net -[direnv-inst]: https://direnv.net/docs/installation.html -[Nix]: https://nixos.org/nix/ -[mg]: https://code.tvl.fyi/tree/tools/magrathea