From ae09d7ba528760f9c9b4f92d905d35c46d50ddca Mon Sep 17 00:00:00 2001 From: Michael Hoang Date: Sat, 9 Nov 2024 03:14:01 +1100 Subject: [PATCH 1/4] readme: remove outdated instructions for manually managing `/etc/bashrc` --- README.md | 7 ------- 1 file changed, 7 deletions(-) diff --git a/README.md b/README.md index d3aec37..602ce08 100644 --- a/README.md +++ b/README.md @@ -20,13 +20,6 @@ nix-build https://github.com/LnL7/nix-darwin/archive/master.tar.gz -A installer ./result/bin/darwin-installer ``` -> NOTE: the system activation scripts don't overwrite existing etc files, so files like `/etc/bashrc` and `/etc/zshrc` won't be -> updated by default. If you didn't use the installer or skipped some of the options you'll have to take care of this yourself. -> Either modify the existing file to source/import the one from `/etc/static` or remove it. Some examples: - -- `mv /etc/bashrc /etc/bashrc.before-nix-darwin` -- `echo 'if test -e /etc/static/bashrc; then . /etc/static/bashrc; fi' | sudo tee -a /etc/bashrc` - ## Updating The installer will configure a channel for this repository. From 2fe3de580e02a3d867134d6632525cf93ffaf0cb Mon Sep 17 00:00:00 2001 From: Michael Hoang Date: Sat, 9 Nov 2024 03:14:01 +1100 Subject: [PATCH 2/4] readme: fix badge --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 602ce08..82a094d 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ # nix-darwin -![Test](https://github.com/LnL7/nix-darwin/workflows/Test/badge.svg) +[![Test](https://github.com/LnL7/nix-darwin/actions/workflows/test.yml/badge.svg)](https://github.com/LnL7/nix-darwin/actions/workflows/test.yml) Nix modules for darwin, `/etc/nixos/configuration.nix` for macOS. From 050b7db4451bbca9798d09661f098cb0033779b5 Mon Sep 17 00:00:00 2001 From: Michael Hoang Date: Sat, 9 Nov 2024 03:14:01 +1100 Subject: [PATCH 3/4] installer: don't tell users to source bashrc Fixes #380 --- pkgs/darwin-installer/default.nix | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pkgs/darwin-installer/default.nix b/pkgs/darwin-installer/default.nix index 37a391c..5c6d801 100644 --- a/pkgs/darwin-installer/default.nix +++ b/pkgs/darwin-installer/default.nix @@ -95,7 +95,7 @@ stdenv.mkDerivation { echo >&2 " Open '$config' to get started." echo >&2 " See the README for more information: https://github.com/LnL7/nix-darwin/blob/master/README.md" echo >&2 - echo >&2 " Don't forget to start a new shell or source /etc/static/bashrc." + echo >&2 " Please log out and log in again to make sure nix-darwin is properly loaded." echo >&2 exit ''; From 5a1ae6a6e41362fb52a682fd3d5f19585131d5de Mon Sep 17 00:00:00 2001 From: Michael Hoang Date: Sat, 9 Nov 2024 03:14:01 +1100 Subject: [PATCH 4/4] readme: add prerequisites section --- README.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 82a094d..b9e3de7 100644 --- a/README.md +++ b/README.md @@ -9,9 +9,16 @@ Nix modules for darwin, `/etc/nixos/configuration.nix` for macOS. This project aims to bring the convenience of a declarative system approach to macOS. nix-darwin is built up around [Nixpkgs](https://github.com/NixOS/nixpkgs), quite similar to [NixOS](https://nixos.org/). -## Installing +## Prerequisites -To install nix-darwin, a working installation of [Nix](https://github.com/NixOS/nix#installation) is required. +The only prerequisite is a Nix implementation, both Nix and Lix are supported. + +As the official Nix installer does not include an automated uninstaller, and manual uninstallation on macOS is a complex process, we recommend using one of the following installers instead: + +- The [Nix installer from Determinate Systems](https://github.com/DeterminateSystems/nix-installer?tab=readme-ov-file#determinate-nix-installer) is only recommended for use with flake-based setups. **Make sure you use it without the `--determinate` flag**. The `--determinate` flag installs the Determinate Nix distribution which does not work out of the box with nix-darwin. +* The [Lix installer](https://lix.systems/install/#on-any-other-linuxmacos-system) supports both flake-based and channel-based setups. + +## Installing If you wish to use nix-darwin with flakes, please refer to the [flakes](#flakes) section.