docs

nix-community · Aug 8, 2023 · f6fd4d6 · f6fd4d6
1 parent 16657ef
commit f6fd4d6
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1 +1,5 @@
 # Changelog
+
+## v0.1.0 - 2023-08-08
+
+First release
diff --git a/README.md b/README.md
@@ -1 +1,19 @@
 # zon2nix
+
+Convert the dependencies in `build.zig.zon` to a Nix expression
+
+## Usage
+
+```bash
+zon2nix > deps.nix
+zon2nix zls > deps.nix
+zon2nix zls/build.zig.zon > deps.nix
+```
+
+To use the generated file, add this to your Nix expression:
+
+```nix
+postPatch = ''
+  ln -s ${callPackage ./deps.nix { }} $ZIG_GLOBAL_CACHE_DIR/p
+'';
+```