Skip to content

Commit 717da15

Browse files
authored
Merge pull request #267 from DeterminateSystems/lucperkins/fh-1152-clarify-that-nix-src-is-not-determinate-nix
Re-word README description of the project
2 parents ce8bac0 + d78e2ee commit 717da15

4 files changed

Lines changed: 28 additions & 9 deletions

File tree

README.md

Lines changed: 25 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,18 +9,31 @@
99
&nbsp;<a href="https://www.linkedin.com/company/determinate-systems" target="_blank"><img alt="LinkedIn" src="https://img.shields.io/badge/LinkedIn-1667be?style=for-the-badge&logo=linkedin&logoColor=%23ffffff"></a>&nbsp;
1010
</p>
1111

12-
# Determinate Nix
12+
# The Determinate Nix CLI
1313

1414
[![CI](https://github.com/DeterminateSystems/nix-src/workflows/CI/badge.svg)](https://github.com/DeterminateSystems/nix-src/actions/workflows/ci.yml)
1515

16-
This repository houses the source for [**Determinate Nix**][det-nix], a downstream distribution of [Nix][upstream] created and maintained by [Determinate Systems][detsys].
17-
Nix is a powerful [language], [package manager][package-management], and [CLI] for [macOS](#macos), [Linux](linux), and other Unix systems that enables you to create fully reproducible [development environments][envs], to build [packages] in sandboxed environments, to build entire Linux systems using [NixOS], and much more.
16+
**Nix** is a powerful [language], [package manager][package-management], and [build tool][cli] for [macOS](#macos), [Linux](#linux), and other Unix systems.
17+
It enables you to create fully reproducible [development environments][envs], to build [packages] in sandboxed environments, to build entire Linux systems using [NixOS], and much more.
18+
19+
[**Determinate Nix**][det-nix] is a downstream distribution of [Nix][upstream] created and maintained by [Determinate Systems][detsys].
20+
It has two components:
21+
22+
- The Determinate Nix CLI, a distribution of the Nix CLI built from this repository.
23+
It's based on the [upstream Nix CLI][upstream] and continuously rebased against it, but adds a wide variety of [features] and [improvements][changelog].
24+
- [Determinate Nixd][dnixd] is a useful daemon for Linux and macOS that handles vital tasks like configuration and enterprise certificate management.
25+
26+
Determinate Nix is built on SOC-2-Type-II-compliant infrastructure using [Determinate Secure Packages][secure-packages], released via a carefully orchestrated process, and, for Determinate Systems customers, backed by formal security response SLAs that meet stringent compliance standards.
27+
28+
> [!NOTE]
29+
> Determinate Nix, by definition, consists of _both_ the components listed above.
30+
> While it's possible to use the code in this repository to run just our downstream Nix CLI, we do _not_ officially support this experience and provide none of the guarantees or SLAs that we provide for Determinate Nix proper.
1831
1932
Determinate Nix is part of the [Determinate platform][determinate], which also includes [FlakeHub], a secure flake repository with features like [FlakeHub Cache][cache], [private flakes][private-flakes], and [semantic versioning][semver] (SemVer) for [flakes].
2033

21-
## Installing Determinate
34+
## Installing Determinate Nix
2235

23-
You can install Determinate on [macOS](#macos), non-NixOS [Linux](#linux) and WSL, and [NixOS](#nixos).
36+
You can install Determinate Nix on [macOS](#macos), non-NixOS [Linux](#linux) and WSL, and [NixOS](#nixos).
2437

2538
### macOS
2639

@@ -32,12 +45,13 @@ Click [here][gui] to download and run it.
3245
On Linux, including Windows Subsystem for Linux (WSL), we recommend installing Determinate Nix using [Determinate Nix Installer][installer]:
3346

3447
```shell
35-
curl -fsSL https://install.determinate.systems/nix | sh -s -- install --determinate
48+
curl -fsSL https://install.determinate.systems/nix | sh -s -- install
3649
```
3750

3851
### NixOS
3952

4053
On [NixOS], we recommend following our [dedicated installation guide][nixos-install].
54+
We also provide both [Amazon Machine Images][amis] (AMIs) and [ISOs] for using Determinate on NixOS.
4155

4256
## Other resources
4357

@@ -63,7 +77,9 @@ For deeply technical reference material, see the [Determinate Nix manual][manual
6377

6478
Check the [contributing guide][contributing] if you want to get involved with developing Nix.
6579

80+
[amis]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AMIs.html
6681
[cache]: https://docs.determinate.systems/flakehub/cache
82+
[changelog]: https://determinate.systems/blog/categories/changelog
6783
[cli]: https://manual.determinate.systems/command-ref/new-cli/nix.html
6884
[contributing]: ./CONTRIBUTING.md
6985
[det-nix]: https://docs.determinate.systems/determinate-nix
@@ -72,10 +88,12 @@ Check the [contributing guide][contributing] if you want to get involved with de
7288
[dnixd]: https://docs.determinate.systems/determinate-nix#determinate-nixd
7389
[eelco]: https://determinate.systems/people/eelco-dolstra
7490
[envs]: https://zero-to-nix.com/concepts/dev-env
91+
[features]: https://docs.determinate.systems/determinate-nix/#special-features
7592
[flakehub]: https://flakehub.com
7693
[flakes]: https://zero-to-nix.com/concepts/flakes
7794
[gui]: https://install.determinate.systems/determinate-pkg/stable/Universal
7895
[installer]: https://github.com/DeterminateSystems/nix-installer
96+
[isos]: https://github.com/DeterminateSystems/nixos-iso
7997
[language]: https://zero-to-nix.com/concepts/nix-language
8098
[license]: ./COPYING
8199
[manual]: https://manual.determinate.systems
@@ -85,6 +103,7 @@ Check the [contributing guide][contributing] if you want to get involved with de
85103
[packages]: https://zero-to-nix.com/concepts/packages
86104
[package-management]: https://zero-to-nix.com/concepts/package-management
87105
[private-flakes]: https://docs.determinate.systems/flakehub/private-flakes
106+
[secure-packages]: https://determinate.systems/secure-packages
88107
[semver]: https://docs.determinate.systems/flakehub/concepts/semver
89108
[thesis]: https://edolstra.github.io/pubs/phd-thesis.pdf
90109
[upstream]: https://github.com/NixOS/nix

doc/manual/source/installation/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ For Linux and Windows Subsystem for Linux (WSL) users:
55

66
```console
77
curl --proto '=https' --tlsv1.2 -sSf -L https://install.determinate.systems/nix | \
8-
sh -s -- install --determinate
8+
sh -s -- install
99
```
1010

1111
## Distributions

doc/manual/source/introduction.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ For Linux and Windows Subsystem for Linux (WSL) users:
1010

1111
```console
1212
curl --proto '=https' --tlsv1.2 -sSf -L https://install.determinate.systems/nix | \
13-
sh -s -- install --determinate
13+
sh -s -- install
1414
```
1515

1616
## How Nix works

doc/manual/source/quick-start.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ For more in-depth information you are kindly referred to subsequent chapters.
99

1010
```console
1111
$ curl --proto '=https' --tlsv1.2 -sSf -L https://install.determinate.systems/nix | \
12-
sh -s -- install --determinate
12+
sh -s -- install
1313
```
1414

1515
The install script will use `sudo`, so make sure you have sufficient rights.

0 commit comments

Comments
 (0)