Skip to content

Commit

Permalink
Language and readme update (#612)
Browse files Browse the repository at this point in the history
Language and readme update
  • Loading branch information
grahamc authored Aug 23, 2023
1 parent 329861f commit 1575695
Showing 1 changed file with 12 additions and 10 deletions.
22 changes: 12 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
# The Determinate Nix Installer

_🎉 Celebrating over 500,000 successful installations! 🎉_

[![Crates.io](https://img.shields.io/crates/v/nix-installer)](https://crates.io/crates/nix-installer)
[![Docs.rs](https://img.shields.io/docsrs/nix-installer)](https://docs.rs/nix-installer/latest/nix_installer/)

`nix-installer` is an opinionated alternative to the [official Nix install scripts](https://nixos.org/download.html).
`nix-installer`, the fast and reliable Nix installer.


```bash
Expand All @@ -27,7 +29,7 @@ The `nix-installer` tool is ready to use in a number of environments:
## Installation Differences

Differing from the current official [Nix](https://github.com/NixOS/nix) installer scripts:
Differing from the upstream [Nix](https://github.com/NixOS/nix) installer scripts:

* In `nix.conf`:
+ the `auto-allocate-uids`, `nix-command` and `flakes` features are enabled
Expand All @@ -41,17 +43,16 @@ Differing from the current official [Nix](https://github.com/NixOS/nix) installe

## Motivations

The current Nix install scripts do an excellent job, however they are difficult to maintain. Subtle differences in the shell implementations and certain characteristics of bash scripts make it difficult to make meaningful changes to the installer.
The upstream scripts do a good job, however they are difficult to maintain.
Subtle differences in the shell implementations and certain characteristics of Bash scripts make it difficult to make meaningful changes to the installer.

Our team wishes to experiment with the idea of an installer in a more structured language and see if this is a worthwhile alternative. Along the way, we are also exploring a few other ideas, such as:
The Determinate Nix installer has numerous advantages:

* keeping an installation receipt for easy uninstallation
* offering users a chance to review an accurate, calculated install plan
* having 'planners' which can create appropriate install plans
* keeping an installation receipt for uninstallation
* having 'planners' which can create appropriate install plans for complicated targets
* offering users with a failing install the chance to do a best-effort revert
* doing whatever tasks we can in parallel

So far, our explorations have been quite fruitful, so we wanted to share and keep exploring.
* improving performance by maximizing parallel operations

## Usage

Expand All @@ -69,7 +70,8 @@ $ chmod +x nix-installer
```

> **Note**
> `nix-installer` will elevate itself if needed using `sudo`. If you use `doas` or `please` you may need to elevate `nix-installer` yourself.
> `nix-installer` will elevate itself if needed using `sudo`.
> If you use `doas` or `please` you may need to elevate `nix-installer` yourself.
`nix-installer` installs Nix by following a *plan* made by a *planner*. Review the available planners:

Expand Down

0 comments on commit 1575695

Please sign in to comment.