From 9d80a6de6653bd55977abd1b3a8aea14224979c5 Mon Sep 17 00:00:00 2001
From: Tobias Pflug <tobias.pflug@gmail.com>
Date: Sat, 2 May 2020 18:56:30 +0200
Subject: [PATCH] Add comment about edolstra/flake-compat

Add a comment to default.nix and shell.nix briefly outlining what
flake-compat/default.nix does.
---
 default.nix | 3 +++
 shell.nix   | 3 +++
 2 files changed, 6 insertions(+)

diff --git a/default.nix b/default.nix
index b22e926e..32d510a3 100644
--- a/default.nix
+++ b/default.nix
@@ -1,3 +1,6 @@
+# The `default.nix` in flake-compat reads `flake.nix` and `flake.lock` from `src` and
+# returns an attribute set of the shape `{ defaultNix, shellNix }`
+
 (import (fetchTarball https://github.com/edolstra/flake-compat/archive/master.tar.gz) {
   src = builtins.fetchGit ./.;
 }).defaultNix
diff --git a/shell.nix b/shell.nix
index db84e3d0..8b8aa5aa 100644
--- a/shell.nix
+++ b/shell.nix
@@ -1,3 +1,6 @@
+# The `default.nix` in flake-compat reads `flake.nix` and `flake.lock` from `src` and
+# returns an attribute set of the shape `{ defaultNix, shellNix }`
+
 (import (fetchTarball https://github.com/edolstra/flake-compat/archive/master.tar.gz) {
   src = builtins.fetchGit ./.;
 }).shellNix