Initial commit.

1 files changed, 36 insertions, 0 deletions

diff --git a/README.org b/README.org
new file mode 100644
index 0000000..c1e52df
--- /dev/null
+++ b/README.org
@@ -0,0 +1,36 @@
+* What is this?
+
+This repository provides package definitions for the functional
+package manager GNU Guix.
+
+* What’s in it?
+
+The packages in this repository fall into one of the following categories:
+
+- personal variants of packages that are already part of Guix
+
+- packages that should eventually be part of Guix but that cannot
+  fully be built from source yet
+
+- software that has not been (fully) released under a libre license or
+  where the license situation is unclear
+
+* How to use this?
+
+Guix looks for package definitions in every module that can be found
+on the =GUIX_PACKAGE_PATH=, an environment variable holding a list of
+directories.
+
+To enable the fully libre-licensed packages, add the “libre” directory
+to the =GUIX_PACKAGE_PATH=:
+
+#+BEGIN_SRC sh
+export GUIX_PACKAGE_PATH=/path/to/libre:${GUIX_PACKAGE_PATH}
+#+END_SRC
+
+If you also want to use the tainted or non-free packages you need to
+also add the “non-free” directory to the =GUIX_PACKAGE_PATH= variable:
+
+#+BEGIN_SRC sh
+export GUIX_PACKAGE_PATH=/path/to/non-free:${GUIX_PACKAGE_PATH}
+#+END_SRC