1 files changed, 29 insertions, 0 deletions

diff --git a/contrib/guix.README b/contrib/guix.README
new file mode 100644
index 000000000..d73b0f4aa
--- /dev/null
+++ b/contrib/guix.README
@@ -0,0 +1,29 @@
+guix.scm contains Guix package definitions that can be used to
+override the ones found in Guix's GNU distribution.
+
+Guix packagers are encouraged to adopt and adjust these definitions.
+
+GNUnet developers can use this for easily setting up a development or
+test environment using Guix.
+
+When using the package definition for building a package this will
+pick up the current development code. The version of the resulting
+package is the output of 'git describe --tags'.
+
+To make guix build the development package defined here, use the
+following command:
+
+  guix build -f <gnunet.git>/contrib/guix
+
+To spawn a (development) environment with GNUnet's dependencies
+installed, run:
+
+  guix environment --load-path=<gnunet.git>/contrib/guix.scm
+
+To spawn a (test) environment with GNUnet available in this
+environment, run:
+
+  guix environment --load-path=<gnunet.git>/contrib/guix.scm --ad-hoc guix
+
+It is recommented to also pass the '--pure' option to guix, to make
+sure the environment is not polluted with existing packages.