feat: README for /lib

This commit is contained in:
Ryan Yin
2023-08-16 18:38:44 +08:00
parent f6630bc6e0
commit 24cd473387

View File

@@ -1,8 +1,8 @@
# Library
Some Helper functions for the project:
Some helper functions, used by `flake.nix` to reduce code duplication and make it easier to add new machines:
1. `macosSystem.nix`: A function to generate attribute set for macOS([nix-darwin](https://github.com/LnL7/nix-darwin)), used by `flake.nix` to reduce code duplication and make it easier to add new machines.
2. `nixosSystem.nix`: A function to generate attribute set for NixOS, used by `flake.nix` to reduce code duplication and make it easier to add new machines.
3. `colmenaSystem.nix`: A function to generate attribute set for remote deployment using [colmena](https://github.com/zhaofengli/colmena), used by `flake.nix` to reduce code duplication and make it easier to add new machines.
1. `macosSystem.nix`: A function to generate config(attribute set) for macOS([nix-darwin](https://github.com/LnL7/nix-darwin)).
2. `nixosSystem.nix`: A function to generate config(attribute set) for NixOS.
3. `colmenaSystem.nix`: A function that generate config(another function) for remote deployment using [colmena](https://github.com/zhaofengli/colmena).