diff --git a/book/SUMMARY.md b/book/SUMMARY.md index 136c331d..34bdc3d3 100644 --- a/book/SUMMARY.md +++ b/book/SUMMARY.md @@ -4,6 +4,7 @@ * [Code of conduct](./code-of-conduct.md) * [Changelog](./changelog.md) * [Installing](./installing.md) + * [Supported targets](./installing/supported-targets.md) * [Migrating to/from Conduit](./installing/migrating-conduit.md) * [Contributing](./contributing.md) * [Coordinated vulnerability disclosure](./contributing/security.md) diff --git a/book/installing.md b/book/installing.md index 7de21af9..a784ed3e 100644 --- a/book/installing.md +++ b/book/installing.md @@ -2,3 +2,6 @@ This chapter will explain how to start running a Grapevine instance for the first time. + +**Note:** Pre-built binaries can be found in the [**Supported +targets**](./installing/supported-targets.md) subchapter. diff --git a/book/installing/supported-targets.md b/book/installing/supported-targets.md new file mode 100644 index 00000000..b099dd1d --- /dev/null +++ b/book/installing/supported-targets.md @@ -0,0 +1,37 @@ +# Supported targets + + + +| Architecture | Vendor | OS | libc | Linkage | Tier | Availability[^1], [^2] | +|-|-|-|-|-|-|-| +| aarch64 | unknown | linux | musl | static | 2 | Nix, [Download](https://gitlab.computer.surgery/api/v4/projects/matrix%2Fgrapevine/jobs/artifacts/main/raw/grapevine-static-aarch64-unknown-linux-musl?job=artifacts) | +| x86_64 | unknown | linux | glibc | dynamic | 1 | Nix | +| x86_64 | unknown | linux | musl | static | 2 | Nix, [Download](https://gitlab.computer.surgery/api/v4/projects/matrix%2Fgrapevine/jobs/artifacts/main/raw/grapevine-static-x86_64-unknown-linux-musl?job=artifacts) | + +[^1]: All download links refer to the latest build of the `main` branch. +[^2]: All targets can theoretically also be built from source without Nix. + However, this may require spending several hours debugging build systems. + +## Target tiers + +The "Tier" column for each target indicates the level of support that target +has. Below is an explanation of what each tier means. + +### Tier 1 + +Tier 1 targets are guaranteed to: + +* Build +* Pass the test suite + +### Tier 2 + +Tier 2 targets are guaranteed to: + +* Build + +## Unsupported targets + +Targets that don't appear in the table at the top of this page are unsupported. +At any given time, such targets may or may not build, and may or may not pass +the test suite. diff --git a/book/introduction.md b/book/introduction.md index edebd33b..4f02e389 100644 --- a/book/introduction.md +++ b/book/introduction.md @@ -91,12 +91,10 @@ the importance of the reliability of a project like this. ## Can I use it? Theoretically yes, but it's not in a good state for general users yet. There -[isn't very much user-facing docs yet][docs-issue], we -[don't have releases yet][releases-issue], we don't currently publish any binary -builds, and there are several breaking changes to the conduit config that -haven't been documented in detail yet. If building from source and figuring out -the config by reading source code/commit messages doesn't scare you away, go -for it! +[isn't very much user-facing docs yet][docs-issue], we [don't have releases +yet][releases-issue], and there are several breaking changes to the conduit +config that haven't been documented in detail yet. If these issues don't scare +you away, go for it! If you use nixos, [here's an example][nixos-example].