summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..33858c5
--- /dev/null
+++ b/README.md
@@ -0,0 +1,13 @@
+# ziggy-with-it
+
+A small example of a [Nix flake](https://nix.dev/concepts/flakes) for a [Zig](https://ziglang.org/) project!
+
+## Features
+
+- A [development shell](https://nix.dev/tutorials/first-steps/ad-hoc-shell-environments)
+- `zig` from `master` via [mitchellh/zig-overlay](https://github.com/mitchellh/zig-overlay)
+- A package built with [`zig.hook`](https://ryantm.github.io/nixpkgs/hooks/zig/#zig-hook) and [`nix-community/zon2nix`](https://github.com/nix-community/zon2nix)
+
+## Thanks
+
+- @paperdave for teaching me how to use `zon` (...or just enough to make this flake work)