aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorRobert Helgesson <robert@rycee.net>2018-12-03 00:48:07 +0100
committerRobert Helgesson <robert@rycee.net>2018-12-04 00:59:52 +0100
commita37b5c9c61d10911b4f094bd9357b4618eb7fa65 (patch)
treea72178fd7648d2a893c82555ca633076f20e9706 /README.md
parent30f3baabafabc25e003dfef5a13f2ea57ef668ab (diff)
Change installation instructions to use nix-channel
This avoids the uncontrollable nature of fetching the tarball as part of the evaluation. Instead the user can decide when to update and also perform rollbacks, if necessary.
Diffstat (limited to 'README.md')
-rw-r--r--README.md39
1 files changed, 14 insertions, 25 deletions
diff --git a/README.md b/README.md
index 56a0e9bc2a0..65fd09382db 100644
--- a/README.md
+++ b/README.md
@@ -54,42 +54,32 @@ Currently the easiest way to install Home Manager is as follows:
NixOS you can control this option using the
[`nix.allowedUsers`][nixosAllowedUsers] system option.
-2. Assign a temporary variable holding the URL to the appropriate
- archive. Typically this is
+2. Add the appropriate Home Manager channel. Typically this is
```console
- $ HM_PATH=https://github.com/rycee/home-manager/archive/master.tar.gz
+ $ nix-channel --add https://github.com/rycee/home-manager/archive/master.tar.gz home-manager
+ $ nix-channel --update
```
if you are following Nixpkgs master or an unstable channel and
```console
- $ HM_PATH=https://github.com/rycee/home-manager/archive/release-18.09.tar.gz
+ $ nix-channel --add https://github.com/rycee/home-manager/archive/release-18.09.tar.gz home-manager
+ $ nix-channel --update
```
if you follow a Nixpkgs version 18.09 channel.
-3. Create an initial Home Manager configuration file:
+3. Install Home Manager and create the first Home Manager generation:
```console
- $ cat > ~/.config/nixpkgs/home.nix <<EOF
- {
- programs.home-manager.enable = true;
- programs.home-manager.path = $HM_PATH;
- }
- EOF
+ $ nix-shell '<home-manager>' -A install
```
-4. Install Home Manager and create the first Home Manager generation:
+ Once finished, Home Manager should be active and available in your
+ user environment.
- ```console
- $ nix-shell $HM_PATH -A install
- ```
-
- Home Manager should now be active and available in your user
- environment.
-
-5. If you do not plan on having Home Manager manage your shell
+3. If you do not plan on having Home Manager manage your shell
configuration then you must source the
```
@@ -107,11 +97,10 @@ Currently the easiest way to install Home Manager is as follows:
to your `~/.profile` file.
-Note, because the `HM_PATH` variable above points to the live Home
-Manager repository you will automatically get updates whenever you
-build a new generation. If you dislike automatic updates then perform
-a Git clone of the desired branch and instead do the above steps with
-`HM_PATH` set to the _absolute path_ of your clone.
+If instead of using channels you want to run Home Manager from a Git
+checkout of the repository then you can use the
+`programs.home-manager.path` option to specify the absolute path to
+the repository.
Usage
-----