Browse Source

contributing: explain how to use local clone

Fixes #180.
keep-around/736e340bde8831e1ffb3e423056a801d0546a83c
Robert Helgesson 1 year ago
parent
commit
9de2549dfb
No account linked to committer's email address
1 changed files with 21 additions and 0 deletions
  1. 21
    0
      CONTRIBUTING.md

+ 21
- 0
CONTRIBUTING.md View File

@@ -41,6 +41,27 @@ descriptive name. Perform your changes on this branch and when you are
41 41
 happy with the result push the branch to GitHub and
42 42
 [create a pull request][].
43 43
 
44
+Assuming your clone is at `$HOME/devel/home-manager` then you can make
45
+the `home-manager` command use it by either
46
+
47
+1.  overriding the default path by using the `-I` command line option:
48
+
49
+        home-manager -I home-manager=$HOME/devel/home-manager
50
+
51
+    or
52
+
53
+2.  changing the default path by ensuring your configuration includes
54
+
55
+        programs.home-manager.enable = true;
56
+        programs.home-manager.path = "$HOME/devel/home-manager";
57
+
58
+    and running `home-manager switch` to activate the change.
59
+    Afterwards, `home-manager build` and `home-manager switch` will
60
+    use your cloned repository.
61
+
62
+The first option is good if you only temporarily want to use your
63
+clone.
64
+
44 65
 ### Commits ###
45 66
 
46 67
 The commits in your pull request should be reasonably self-contained,

Loading…
Cancel
Save