foodogsquared/nix-module-wrapper-manager-fds
1
0
Fork 0
mirror of https://github.com/foo-dogsquared/nix-module-wrapper-manager-fds.git synced 2025-01-30 22:57:58 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs/website: update project overview and user guide

Browse Source
This commit is contained in:
Gabriel Arazas 2024-11-12 18:11:14 +08:00
parent 54f6be1861
commit 7313cfa666
No known key found for this signature in database
GPG Key ID: 62104B43D00AA360
2 changed files with 17 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/website/content/en/project-overview.adoc
View File

@ -96,6 +96,14 @@ Unlike the other methods, the flake output is the user entrypoint so no need to
}
----
[#getting-started]
== Getting started
Now that you have wrapper-manager-fds on the go, let's have a breakdown of what it is, exactly.
The project itself is made of different parts which you can use for different purposes.
[#user-entrypoint]
=== User entrypoint
@ -130,14 +138,6 @@ wrapperManagerLib.env.build { }
* `overlays` is a set of nixpkgs overlays to be applied by the user.
So far, there's only one overlay called `default` containing the wrapper-manager library set.
[#getting-started]
== Getting started
Now that you have wrapper-manager-fds on the go, let's have a breakdown of what it is, exactly.
The project itself is made of different parts which you can use for different purposes.
[#the-module-environment]
=== The module environment

11
docs/website/content/en/user-guide.adoc
View File

@ -45,9 +45,16 @@ in
specialArgs = { hello = "WORLD"; };
}
----
--
* There is also `wrapperManagerLib.env.eval` which is just evaluating a wrapper-manager package and nothing else. footnote:[In fact, `wrapperManagerLib.env.build` is just a wrapper around this function getting the toplevel package.]
Useful for creating your own integrations in other module environments.
It should accept the same arguments as the build function.
* You can take advantage of the integration modules for home-manager and NixOS and it automatically adds them into their respective package list (i.e., `home.packages` and `environment.systemPackages`).
They are mainly configured through `wrapper-manager.packages` which is an attribute set representing a set of package.
For more details, you can see <<with-nixos-and-home-manager>>.
[#using-wrapper-manager]
== Using wrapper-manager
@ -416,7 +423,7 @@ It is available to be viewed as `wrapper-manager.nix(5)` (i.e., `man 5 wrapper-m
* An HTML manual can be brought over by setting `wrapper-manager.documentation.html.enable` to `true`.
The HTML manual package has a desktop entry file titled `wrapper-manager manual` in the common application launchers (e.g., rofi, GNOME Shell app launcher).
You can also set additional modules to be included with `wrapper-manager.documentation.extraModules` in case you have custom wrapper-manager modules that you want to be nicely integrated.
You can also set additional modules to be included with `wrapper-manager.documentation.extraModules` in case you have custom wrapper-manager modules.
[#differences-from-original-wrapper-manager]