summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2f0ee38
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+# vdf - version diff for Nix
+
+vdf was inspired by [nvd] but groups direct dependencies first rather
+than highlighting them as bold. Some more features are planned.
+
+See the [man page](manual.md).
+
+## Contributing
+
+The unit tests in `main_test.go` can be run with `go test`.
+
+The integration tests in `integration_test.go` can be run with `go test -tags=integration`
+(running them requires `nix-build` and `nixos-rebuild` on the PATH).
+
+[nvd]: https://khumba.net/projects/nvd/