foodogsquared/nixos-config
1
0
Fork 0
mirror of https://github.com/foo-dogsquared/nixos-config.git synced 2025-01-30 22:57:55 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

docs: add README for custom library

Browse Source
This commit is contained in:
Gabriel Arazas 2024-06-21 20:33:22 +08:00
parent 6bea4da5be
commit e1ed34dc29
No known key found for this signature in database
GPG Key ID: 62104B43D00AA360
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
lib/README.adoc Normal file
View File

@ -0,0 +1,12 @@
= foodogsquared custom nixpkgs library
:toc:
This is my custom library set of functions to be included within each of the environment.
They are included in each of the environment as `foodogsquaredLib` module argument.
It is similarly structured from nixpkgs (though it is directly copied after I've implemented how Bahaghari structures their library set) where it is an extensible fixed point making it easy to use after adding new functions into the set AND extend it if you want to through the `$LIB.extend` function.
The structure is even copied from nixpkgs where each of the subset is in the fixed point also stored with the same name.
The only exception to this are the environment-specific subsets where they are only intended to be imported into NixOS, home-manager, and the like.
This is in the link:./env-specific[`./env-specific` directory].
Furthermore, env-specific subsets have a lesser restriction of allowing the configuration object to be included in there (though it is discouraged to use it but that's on a case-by-case basis).