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

docs(snix): drop getting-started.md

Browse source 
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 <masterancpp@gmail.com>
Autosubmit: Florian Klink <flokli@flokli.de>
This commit is contained in:
Florian Klink 2025-03-24 01:40:05 +00:00 • committed by clbot
parent 96a02c100f
commit e639af1775
2 changed files with 0 additions and 62 deletions
Download patch file Download diff file Expand all files Collapse all files

3
snix/docs/src/SUMMARY.md
View file

@ -1,8 +1,5 @@
# Summary
# Welcome
* [Getting Started](./getting-started.md)
# Tvix
- [Architecture & data flow](./architecture.md)
- [TODOs](./TODO.md)

59
snix/docs/src/getting-started.md
View file

@ -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