From 607be58a80203306b6132b87dce099750c524ec7 Mon Sep 17 00:00:00 2001 From: Luc Perkins Date: Mon, 19 May 2025 11:20:40 -0400 Subject: [PATCH 1/6] Update CI badge URLs --- README.md | 35 ++++++++++++++++++++++------------- 1 file changed, 22 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 54a6fcc39..35c0bcfb3 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ -# Nix +# Determinate Nix -[![Open Collective supporters](https://opencollective.com/nixos/tiers/supporter/badge.svg?label=Supporters&color=brightgreen)](https://opencollective.com/nixos) -[![CI](https://github.com/NixOS/nix/workflows/CI/badge.svg)](https://github.com/NixOS/nix/actions/workflows/ci.yml) +[![CI](https://github.com/DeterminateSystems/nix-src/workflows/CI/badge.svg)](https://github.com/DeterminateSystems/nix-src/actions/workflows/ci.yml) -Nix is a powerful package manager for Linux and other Unix systems that makes package -management reliable and reproducible. Please refer to the [Nix manual](https://nix.dev/reference/nix-manual) -for more details. +This repository houses the source for [Determinate Nix][det-nix], a downstream distribution of [Nix][upstream]. +Nix is a powerful language, package manager, and CLI for Linux and other Unix systems that makes package management reliable and reproducible. + +--- ## Installation and first steps @@ -26,13 +26,22 @@ Check the [contributing guide](./CONTRIBUTING.md) if you want to get involved wi Nix was created by Eelco Dolstra and developed as the subject of his PhD thesis [The Purely Functional Software Deployment Model](https://edolstra.github.io/pubs/phd-thesis.pdf), published 2006. Today, a world-wide developer community contributes to Nix and the ecosystem that has grown around it. -- [The Nix, Nixpkgs, NixOS Community on nixos.org](https://nixos.org/) -- [Official documentation on nix.dev](https://nix.dev) -- [Nixpkgs](https://github.com/NixOS/nixpkgs) is [the largest, most up-to-date free software repository in the world](https://repology.org/repositories/graphs) -- [NixOS](https://github.com/NixOS/nixpkgs/tree/master/nixos) is a Linux distribution that can be configured fully declaratively -- [Discourse](https://discourse.nixos.org/) -- [Matrix](https://matrix.to/#/#nix:nixos.org) +- [The Nix, Nixpkgs, NixOS Community on nixos.org][website] +- [Official documentation on nix.dev][nix.dev] +- [NixOS] is a Linux distribution that can be configured fully declaratively +- [Discourse] +- [Matrix] ## License -Nix is released under the [LGPL v2.1](./COPYING). +[Upstream Nix][upstream] is released under the [LGPL v2.1][license] license. +[Determinate Nix][det-nix] is also released under LGPL v2.1 based on the terms of that license. + +[det-nix]: https://docs.determinate.systems/determinate-nix +[discourse]: https://discourse.nixos.org +[license]: ./COPYING +[matrix]: https://matrix.to/#/#nix:nixos.org +[nix.dev]: https://nix.dev +[nixos]: https://github.com/NixOS/nixpkgs/tree/master/nixos +[upstream]: https://github.com/NixOS/nix +[website]: https://nixos.org From a56ecb5302ef9be3c0ece8b89f12b5da62fb72a2 Mon Sep 17 00:00:00 2001 From: Luc Perkins Date: Tue, 20 May 2025 10:20:14 -0400 Subject: [PATCH 2/6] Add logos --- README.md | 55 +++++++++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 47 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 35c0bcfb3..9b1390c9f 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,44 @@ +

+ +

+

+  Discord  +  Bluesky  +  Mastodon  +  Twitter  +  LinkedIn  +

+ # Determinate Nix [![CI](https://github.com/DeterminateSystems/nix-src/workflows/CI/badge.svg)](https://github.com/DeterminateSystems/nix-src/actions/workflows/ci.yml) -This repository houses the source for [Determinate Nix][det-nix], a downstream distribution of [Nix][upstream]. +This repository houses the source for [**Determinate Nix**][det-nix], a downstream distribution of [Nix][upstream] created and maintained by [Determinate Systems][detsys]. Nix is a powerful language, package manager, and CLI for Linux and other Unix systems that makes package management reliable and reproducible. +Determinate Nix is + +[Determinate] +[FlakeHub] + +## Installing Determinate + +You can install Determinate on [macOS](#macos), non-NixOS [Linux](#linux), and [NixOS](#nixos). + +### macOS + +On macOS, we recommend using the graphical installer from Determinate Systems. +Click [here][gui] to download and run it. + +### Linux + +On Linux, including Windows Subsystem for Linux (WSL), we recommend installing Determinate using [Determinate Nix Installer][installer]: + +```shell +curl -fsSL https://install.determinate.systems/nix | sh -s -- install --determinate +``` + + --- ## Installation and first steps @@ -19,29 +53,34 @@ Follow instructions in the Nix reference manual to [set up a development environ ## Contributing -Check the [contributing guide](./CONTRIBUTING.md) if you want to get involved with developing Nix. +Check the [contributing guide][contributing] if you want to get involved with developing Nix. ## Additional resources -Nix was created by Eelco Dolstra and developed as the subject of his PhD thesis [The Purely Functional Software Deployment Model](https://edolstra.github.io/pubs/phd-thesis.pdf), published 2006. +Nix was created by [Eelco Dolstra][eelco] and developed as the subject of his 2006 PhD thesis, [The Purely Functional Software Deployment Model](https://edolstra.github.io/pubs/phd-thesis.pdf). Today, a world-wide developer community contributes to Nix and the ecosystem that has grown around it. - [The Nix, Nixpkgs, NixOS Community on nixos.org][website] +- [Nixpkgs], a collection of well over 100,000 software packages that can be built and managed using Nix - [Official documentation on nix.dev][nix.dev] - [NixOS] is a Linux distribution that can be configured fully declaratively -- [Discourse] -- [Matrix] ## License [Upstream Nix][upstream] is released under the [LGPL v2.1][license] license. [Determinate Nix][det-nix] is also released under LGPL v2.1 based on the terms of that license. +[contributing]: ./CONTRIBUTING.md [det-nix]: https://docs.determinate.systems/determinate-nix -[discourse]: https://discourse.nixos.org +[determinate]: https://docs.determinate.systems +[detsys]: https://determinate.systems +[dnixd]: https://docs.determinate.systems/determinate-nix#determinate-nixd +[eelco]: https://determinate.systems/people/eelco-dolstra +[flakehub]: https://flakehub.com +[gui]: https://install.determinate.systems/determinate-pkg/stable/Universal [license]: ./COPYING -[matrix]: https://matrix.to/#/#nix:nixos.org [nix.dev]: https://nix.dev -[nixos]: https://github.com/NixOS/nixpkgs/tree/master/nixos +[nixpkgs]: https://github.com/NixOS/nixpkgs +[thesis]: https://edolstra.github.io/pubs/phd-thesis.pdf [upstream]: https://github.com/NixOS/nix [website]: https://nixos.org From 7ef76196579885f82fe0fb29b7f46ea1ebc0569d Mon Sep 17 00:00:00 2001 From: Luc Perkins Date: Mon, 2 Jun 2025 10:45:23 -0700 Subject: [PATCH 3/6] Finish initial draft --- README.md | 61 ++++++++++++++++++++++++++++++------------------------- 1 file changed, 33 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index 9b1390c9f..241164e5d 100644 --- a/README.md +++ b/README.md @@ -14,12 +14,9 @@ [![CI](https://github.com/DeterminateSystems/nix-src/workflows/CI/badge.svg)](https://github.com/DeterminateSystems/nix-src/actions/workflows/ci.yml) This repository houses the source for [**Determinate Nix**][det-nix], a downstream distribution of [Nix][upstream] created and maintained by [Determinate Systems][detsys]. -Nix is a powerful language, package manager, and CLI for Linux and other Unix systems that makes package management reliable and reproducible. +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. -Determinate Nix is - -[Determinate] -[FlakeHub] +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]. ## Installing Determinate @@ -32,55 +29,63 @@ Click [here][gui] to download and run it. ### Linux -On Linux, including Windows Subsystem for Linux (WSL), we recommend installing Determinate using [Determinate Nix Installer][installer]: +On Linux, including Windows Subsystem for Linux (WSL), we recommend installing Determinate Nix using [Determinate Nix Installer][installer]: ```shell curl -fsSL https://install.determinate.systems/nix | sh -s -- install --determinate ``` +### NixOS ---- +On [NixOS], we recommend following our [dedicated installation guide][nixos-install]. -## Installation and first steps +## Other resources -Visit [nix.dev](https://nix.dev) for [installation instructions](https://nix.dev/tutorials/install-nix) and [beginner tutorials](https://nix.dev/tutorials/first-steps). +Nix was created by [Eelco Dolstra][eelco] and developed as the subject of his 2006 PhD thesis, [The Purely Functional Software Deployment Model][thesis]. +Today, a worldwide developer community contributes to Nix and the ecosystem that has grown around it. -Full reference documentation can be found in the [Nix manual](https://nix.dev/reference/nix-manual). +- [Zero to Nix][z2n], Determinate Systems' guide to Nix and [flakes] for beginners +- [Nixpkgs], a collection of well over 100,000 software packages that you can build and manage using Nix +- [NixOS] is a Linux distribution that can be configured fully declaratively +- The Nix, Nixpkgs, and NixOS community on [nixos.org][website] -## Building and developing +## Reference -Follow instructions in the Nix reference manual to [set up a development environment and build Nix from source](https://nix.dev/manual/nix/development/development/building.html). +You can find full reference documentation in the [Determinate Nix manual][manual]. +This resource is a work in progress. + +## License + +[Upstream Nix][upstream] is released under the [LGPL v2.1][license] license. +[Determinate Nix][det-nix] is also released under LGPL v2.1 in accordance with the terms of the upstream license. ## Contributing Check the [contributing guide][contributing] if you want to get involved with developing Nix. -## Additional resources - -Nix was created by [Eelco Dolstra][eelco] and developed as the subject of his 2006 PhD thesis, [The Purely Functional Software Deployment Model](https://edolstra.github.io/pubs/phd-thesis.pdf). -Today, a world-wide developer community contributes to Nix and the ecosystem that has grown around it. - -- [The Nix, Nixpkgs, NixOS Community on nixos.org][website] -- [Nixpkgs], a collection of well over 100,000 software packages that can be built and managed using Nix -- [Official documentation on nix.dev][nix.dev] -- [NixOS] is a Linux distribution that can be configured fully declaratively - -## License - -[Upstream Nix][upstream] is released under the [LGPL v2.1][license] license. -[Determinate Nix][det-nix] is also released under LGPL v2.1 based on the terms of that license. - +[cache]: https://docs.determinate.systems/flakehub/cache +[cli]: https://manual.determinate.systems/command-ref/new-cli/nix.html [contributing]: ./CONTRIBUTING.md [det-nix]: https://docs.determinate.systems/determinate-nix [determinate]: https://docs.determinate.systems [detsys]: https://determinate.systems [dnixd]: https://docs.determinate.systems/determinate-nix#determinate-nixd [eelco]: https://determinate.systems/people/eelco-dolstra +[envs]: https://zero-to-nix.com/concepts/dev-env [flakehub]: https://flakehub.com +[flakes]: https://zero-to-nix.com/concepts/flakes [gui]: https://install.determinate.systems/determinate-pkg/stable/Universal +[language]: https://zero-to-nix.com/concepts/nix-language [license]: ./COPYING -[nix.dev]: https://nix.dev +[manual]: https://manual.determinate.systems [nixpkgs]: https://github.com/NixOS/nixpkgs +[nixos]: https://github.com/NixOS/nixpkgs/tree/master/nixos +[nixos-install]: https://docs.determinate.systems/guides/advanced-installation#nixos +[packages]: https://zero-to-nix.com/concepts/packages +[package-management]: https://zero-to-nix.com/concepts/package-management +[private-flakes]: https://docs.determinate.systems/flakehub/private-flakes +[semver]: https://docs.determinate.systems/flakehub/concepts/semver [thesis]: https://edolstra.github.io/pubs/phd-thesis.pdf [upstream]: https://github.com/NixOS/nix [website]: https://nixos.org +[z2n]: https://zero-to-nix.com From d7c2bcbab67142b8763dc9729e0e20db88a0171c Mon Sep 17 00:00:00 2001 From: Luc Perkins Date: Mon, 2 Jun 2025 10:56:51 -0700 Subject: [PATCH 4/6] Add WSL to list Co-authored-by: Graham Christensen --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 241164e5d..abdc5305c 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ Determinate Nix is part of the [Determinate platform][determinate], which also i ## Installing Determinate -You can install Determinate on [macOS](#macos), non-NixOS [Linux](#linux), and [NixOS](#nixos). +You can install Determinate on [macOS](#macos), non-NixOS [Linux](#linux) and WSL, and [NixOS](#nixos). ### macOS From 7bab53af66847ce8541e57e8ad99db654d6ca8b9 Mon Sep 17 00:00:00 2001 From: Luc Perkins Date: Mon, 2 Jun 2025 11:01:06 -0700 Subject: [PATCH 5/6] Fix dangling link reference --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index abdc5305c..300fb3792 100644 --- a/README.md +++ b/README.md @@ -75,6 +75,7 @@ Check the [contributing guide][contributing] if you want to get involved with de [flakehub]: https://flakehub.com [flakes]: https://zero-to-nix.com/concepts/flakes [gui]: https://install.determinate.systems/determinate-pkg/stable/Universal +[installer]: https://github.com/DeterminateSystems/nix-installer [language]: https://zero-to-nix.com/concepts/nix-language [license]: ./COPYING [manual]: https://manual.determinate.systems From e6bcbacadfa69dd9ad0d654551c65aa50e96aebb Mon Sep 17 00:00:00 2001 From: Luc Perkins Date: Mon, 2 Jun 2025 11:01:33 -0700 Subject: [PATCH 6/6] Rework language around the manual Co-authored-by: Graham Christensen --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index abdc5305c..2bbc3f3d1 100644 --- a/README.md +++ b/README.md @@ -51,8 +51,8 @@ Today, a worldwide developer community contributes to Nix and the ecosystem that ## Reference -You can find full reference documentation in the [Determinate Nix manual][manual]. -This resource is a work in progress. +The primary documentation for Determinate and Determinate Nix is available at [docs.determinate.systems][determinate]. +For deeply technical reference material, see the [Determinate Nix manual][manual] which is based on the upstream Nix manual. ## License