From c2ab2b449c0517ef5eedd696f80d3c22fbca0140 Mon Sep 17 00:00:00 2001
From: Jean-Paul Calderone <exarkun@twistedmatrix.com>
Date: Wed, 4 Sep 2019 16:32:18 -0400
Subject: [PATCH] Basic entry-point docs for the morph stuff

---
 morph/README.rst | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)
 create mode 100644 morph/README.rst

diff --git a/morph/README.rst b/morph/README.rst
new file mode 100644
index 00000000..9e1a2e1b
--- /dev/null
+++ b/morph/README.rst
@@ -0,0 +1,27 @@
+This Directory
+==============
+
+This directory contains Nix-based configuration for the grid.
+This takes the form of Nix expressions in ``.nix`` files
+and some JSON-based configuration in ``.config.json`` files.
+
+This configuration is fed to `morph`_ to make changes to the deployment.
+
+grid.config.json
+----------------
+
+This contains configuration for Tahoe-LAFS.
+
+grid.nix
+--------
+
+This is the `morph`_ entrypoint for the grid.
+This defines the "network" (which is not really related to any IP networking configuration).
+It also defines all of the servers that are part of the grid.
+
+The actual configuration is split into separate files that are imported from this one.
+You can do things like build the network::
+
+  morph build grid.nix
+
+.. _`morph`: https://github.com/DBCDK/morph
-- 
GitLab