lix-project/lix-installer
16
4
Fork 4
Code Issues 23 Code Review (Gerrit) Projects Activity

Fancy-fy the README a bit (#345)

Browse source 
* Fancy-fy the README a bit

* Ensure GH doesn't make flake URLs poorly formatted
This commit is contained in:
Ana Hobden 2023-03-16 10:08:27 -07:00 committed by GitHub
parent 3347ccb9d5
commit 01553de247
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 18 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
README.md
View file

@ -22,7 +22,8 @@ The `nix-installer` tool is ready to use in a number of environments:
| Docker Containers | | ✓ | Stable | | Docker Containers | | ✓ | Stable |
| Linux (i686) | ✓ (via [systemd]) | ✓ | Unstable | | Linux (i686) | ✓ (via [systemd]) | ✓ | Unstable |
> **MacOS note:** Removing users and/or groups may fail if there are no users who are logged in graphically. > **Note**
> On **MacOS only**, removing users and/or groups may fail if there are no users who are logged in graphically.
## Installation Differences ## Installation Differences
@ -66,6 +67,7 @@ $ curl -sL -o nix-installer https://install.determinate.systems/nix/nix-installe
$ chmod +x nix-installer $ 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: `nix-installer` installs Nix by following a *plan* made by a *planner*. Review the available planners:
@ -156,7 +158,7 @@ jobs:
## Without systemd (Linux only) ## Without systemd (Linux only)
> **Warning** > **Warning**
> When installed this way, _only_ `root` or users who can elevate to `root` privileges can run Nix: > When `--init none` is used, _only_ `root` or users who can elevate to `root` privileges can run Nix:
> >
> ```bash > ```bash
> sudo -i nix run nixpkgs#hello > sudo -i nix run nixpkgs#hello
@ -172,7 +174,8 @@ curl --proto '=https' --tlsv1.2 -sSf -L https://install.determinate.systems/nix
In Docker/Podman containers or WSL2 instances where an init (like `systemd`) is not present, pass `--init none`. In Docker/Podman containers or WSL2 instances where an init (like `systemd`) is not present, pass `--init none`.
> When `--init none` is used, only `root` or sudoers can run Nix: > **Warning**
> When `--init none` is used, _only_ `root` or users who can elevate to `root` privileges can run Nix:
> >
> ```bash > ```bash
> sudo -i nix run nixpkgs#hello > sudo -i nix run nixpkgs#hello
@ -206,7 +209,7 @@ ENV PATH="${PATH}:/nix/var/nix/profiles/default/bin"
RUN nix run nixpkgs#hello RUN nix run nixpkgs#hello
``` ```
For Podman containers with an init: For Podman containers with a systemd init:
```dockerfile ```dockerfile
# Dockerfile # Dockerfile
@ -230,7 +233,8 @@ curl --proto '=https' --tlsv1.2 -sSf -L https://install.determinate.systems/nix
If systemd is not enabled, pass `--init none` at the end of the command: If systemd is not enabled, pass `--init none` at the end of the command:
> When `--init none` is used, only `root` or sudoers can run Nix: > **Warning**
> When `--init none` is used, _only_ `root` or users who can elevate to `root` privileges can run Nix:
> >
> ```bash > ```bash
> sudo -i nix run nixpkgs#hello > sudo -i nix run nixpkgs#hello
@ -259,24 +263,24 @@ Build a portable Linux binary on a system with Nix:
```bash ```bash
# to build a local copy # to build a local copy
nix build -L .#nix-installer-static nix build -L ".#nix-installer-static"
# to build the remote main development branch # to build the remote main development branch
nix build -L github:determinatesystems/nix-installer#nix-installer-static nix build -L "github:determinatesystems/nix-installer#nix-installer-static"
# for a specific version of the installer: # for a specific version of the installer:
export NIX_INSTALLER_TAG="v0.5.0" export NIX_INSTALLER_TAG="v0.5.0"
nix build -L github:determinatesystems/nix-installer/$NIX_INSTALLER_TAG#nix-installer-static nix build -L "github:determinatesystems/nix-installer/$NIX_INSTALLER_TAG#nix-installer-static"
``` ```
On Mac: On Mac:
```bash ```bash
# to build a local copy # to build a local copy
nix build -L .#nix-installer nix build -L ".#nix-installer"
# to build the remote main development branch # to build the remote main development branch
nix build -L github:determinatesystems/nix-installer#nix-installer nix build -L "github:determinatesystems/nix-installer#nix-installer"
# for a specific version of the installer: # for a specific version of the installer:
export NIX_INSTALLER_TAG="v0.5.0" export NIX_INSTALLER_TAG="v0.5.0"
nix build -L github:determinatesystems/nix-installer/$NIX_INSTALLER_TAG#nix-installer nix build -L "github:determinatesystems/nix-installer/$NIX_INSTALLER_TAG#nix-installer"
``` ```
Then copy the `result/bin/nix-installer` to the machine you wish to run it on. Then copy the `result/bin/nix-installer` to the machine you wish to run it on.
@ -297,11 +301,13 @@ nix-installer --help
To make this build portable, pass ` --target x86_64-unknown-linux-musl`. To make this build portable, pass ` --target x86_64-unknown-linux-musl`.
> **Note**
> We currently require `--cfg tokio_unstable` as we utilize [Tokio's process groups](https://docs.rs/tokio/1.24.1/tokio/process/struct.Command.html#method.process_group), which wrap stable `std` APIs, but are unstable due to it requiring an MSRV bump. > We currently require `--cfg tokio_unstable` as we utilize [Tokio's process groups](https://docs.rs/tokio/1.24.1/tokio/process/struct.Command.html#method.process_group), which wrap stable `std` APIs, but are unstable due to it requiring an MSRV bump.
## As a library ## As a library
> **Warning**
> Use as a library is still experimental, if you're using this, please let us know and we can make a path to stablization. > Use as a library is still experimental, if you're using this, please let us know and we can make a path to stablization.
Add `nix-installer` to your dependencies: Add `nix-installer` to your dependencies:
@ -310,7 +316,7 @@ Add `nix-installer` to your dependencies:
cargo add nix-installer cargo add nix-installer
``` ```
> **Building a CLI?** Check out the `cli` feature flag for `clap` integration. If you are **building a CLI**, check out the `cli` feature flag for `clap` integration.
You'll also need to edit your `.cargo/config.toml` to use `tokio_unstable` as we utilize [Tokio's process groups](https://docs.rs/tokio/1.24.1/tokio/process/struct.Command.html#method.process_group), which wrap stable `std` APIs, but are unstable due to it requiring an MSRV bump: You'll also need to edit your `.cargo/config.toml` to use `tokio_unstable` as we utilize [Tokio's process groups](https://docs.rs/tokio/1.24.1/tokio/process/struct.Command.html#method.process_group), which wrap stable `std` APIs, but are unstable due to it requiring an MSRV bump: