summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEmily <vcs@emily.moe>2024-11-09 12:04:29 +0000
committerGitHub <noreply@github.com>2024-11-09 12:04:29 +0000
commit5c74ab862c8070cbf6400128a1b56abb213656da (patch)
tree20243adbf4da8789d2756e08995f0ddae9cf80d6
parent5e9e8e7924279a9522357b01c5cbf9abe19c8a44 (diff)
parent5a1ae6a6e41362fb52a682fd3d5f19585131d5de (diff)
Merge pull request #1157 from Enzime/read-me
readme: small improvements
-rw-r--r--README.md20
-rw-r--r--pkgs/darwin-installer/default.nix2
2 files changed, 11 insertions, 11 deletions
diff --git a/README.md b/README.md
index d3aec37..b9e3de7 100644
--- a/README.md
+++ b/README.md
@@ -2,16 +2,23 @@
# 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.
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
+
+The only prerequisite is a Nix implementation, both Nix and Lix are supported.
-To install nix-darwin, a working installation of [Nix](https://github.com/NixOS/nix#installation) is required.
+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.
@@ -20,13 +27,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.
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
'';