diff --git a/users/README.md b/users/README.md index 7000c8e6f..5fdb029c2 100644 --- a/users/README.md +++ b/users/README.md @@ -22,10 +22,17 @@ your users. For a fully fleshed out example, check out the developers personal ``` +## Home Manager +Home Manager support follows the same principles as regular nixos configurations. +All modules defined in [user modules](./modules/module-list.nix) will be imported to +Home Manager. All profiles are availabe in [suites](../suites/default.nix) as userProfiles. +The `userSuites` output will be available in your Home Manager Configuration as +the special argument, `suites`. + ## External Usage You can easily use the defined home-manager configurations outside of NixOS -using the `hmActivations` meta-package defined in the flakes `legacyPackages` -output. The [flk](../doc/flk) helper script makes this even easier. +using the `homeConfigurations` flake output. The [flk](../doc/flk) helper +script makes this even easier. This is great for keeping your environment consistent across Unix systems, including OSX.