soopy.moe
1# Utility Functions
2
3In this section you will find various utility functions available in this flake.
4
5You are free to use them as you wish if you find them useful.
6
7Watch out! Here's a hint box!
8
9```admonish hint title="Hint Box"
10Please take care when using these functions. They are opinionated by nature and are designed to be used on our systems.
11
12There is a high chance for you to be discontent with them. In which case, please feel free to copy them and adapt them
13to your needs.
14
15Also what in the world? Is that discrimination against hint boxes? I demand this be rectified immediately!
16```
17
18## Getting started
19You first need to import this flake as an input.
20
21If you don't know how to do so, you should not be here. Please refer to various Nix documentation first, then come back.
22Using these utilities when you're just starting out causes unnecessary pain later on when it doesn't match your needs.
23
24For NixOS users, it is possible to make the utils module "globally" available in your NixOS configuration modules.
25To do so, please refer to [Tips/"Global" Options](../tips/global-options.md).
26
27We are dogfooding on these functions ourselves so they should be relatively error-free. If you encounter unexpected
28behavior though, do reach out and open an issue/send us a message. We won't bite. Promise.
29
30```admonish hint title="Hint Box"
31Hey! Are you even listening?
32```