aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMiran Bastaja <miran.bastaja04@gmail.com>2024-07-30 16:12:20 +0200
committerMiran Bastaja <miran.bastaja04@gmail.com>2024-07-30 16:12:20 +0200
commita524bf5c41c17975d7e85d87db1dc1d49e472f88 (patch)
tree9ab3e2d69249671c85f670c32aa68b495f94c168 /README.md
Initial commit
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9c9027e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,14 @@
+# Minimal flake utils
+
+This repo contains random bits of code that I often use when creating flakes.
+
+## Included functions
+
+### `eachSystem :: (<system> -> attrs)`
+
+Esentially equivalent to [flake-utils' eachDefaultSystem](https://github.com/numtide/flake-utils/blob/b1d9ab70662946ef0850d488da1c9019f3a9752a/README.md#eachdefaultsystem--system---attrs)
+
+### `mkMinimalShell :: ( {name ? "nix-shell", packages ? [], inputsFrom ? [], shellHook ? "", ...} -> derivation)`
+
+Like [nixpkgs' mkShell](https://ryantm.github.io/nixpkgs/builders/special/mkshell/) but pulls in
+fewer dependencies. The extra arguments (...) are all the attributes of `stdenv.mkDerivation`.