contributing: explain how to use local clone

Fixes #180.
This commit is contained in:
Robert Helgesson 2018-01-14 11:04:01 +01:00
parent 81fb420457
commit 9de2549dfb
No known key found for this signature in database
GPG Key ID: C3DB11069E65DC86
1 changed files with 21 additions and 0 deletions

View File

@ -41,6 +41,27 @@ descriptive name. Perform your changes on this branch and when you are
happy with the result push the branch to GitHub and
[create a pull request][].
Assuming your clone is at `$HOME/devel/home-manager` then you can make
the `home-manager` command use it by either
1. overriding the default path by using the `-I` command line option:
home-manager -I home-manager=$HOME/devel/home-manager
or
2. changing the default path by ensuring your configuration includes
programs.home-manager.enable = true;
programs.home-manager.path = "$HOME/devel/home-manager";
and running `home-manager switch` to activate the change.
Afterwards, `home-manager build` and `home-manager switch` will
use your cloned repository.
The first option is good if you only temporarily want to use your
clone.
### Commits ###
The commits in your pull request should be reasonably self-contained,