From 26fb757c01660d1803d22d28bd8ad20aa50c58fb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Reynir=20Bj=C3=B6rnsson?= Date: Thu, 5 Dec 2024 09:53:59 +0100 Subject: [PATCH] Document scope in README and opam description Fixes #1 --- README.md | 5 ++++- opam-graph.opam | 2 +- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0e9312d..4d68ce8 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,6 @@ # opam-graph -Visualizes dependencies of "opam switch export" as dot or svg. +Visualizes dependencies of "opam switch export --full --freeze" as dot or svg. + +Note that this project is developed to serve https://builds.robur.coop/ and [builder-web](https://git.robur.coop/robur/builder-web/) and makes hard assumptions on the `--full` and `--freeze` flags passed to `opam switch export. +Please reach out to us at [Robur](https://robur.coop/Contact) if you have other needs. diff --git a/opam-graph.opam b/opam-graph.opam index d10bfb5..bf54ef3 100644 --- a/opam-graph.opam +++ b/opam-graph.opam @@ -28,5 +28,5 @@ build: [ synopsis: "Graphing dependencies of opam packages" description: """ This package outputs dependency graphs (in svg and dot) of opam package -universes (opam switch export). +universes (opam switch export --full --freeze). """