From 807e1c1b76f41e967aeb334d30b03cf4d75d81fb Mon Sep 17 00:00:00 2001
From: Jean-Paul Calderone <exarkun@twistedmatrix.com>
Date: Wed, 7 Aug 2019 14:14:34 -0400
Subject: [PATCH] some words about the tests

---
 README.rst | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)

diff --git a/README.rst b/README.rst
index 5fb1dfc6..f1552d5c 100644
--- a/README.rst
+++ b/README.rst
@@ -2,3 +2,34 @@ PrivateStorageio
 ================
 
 The backend for a private, secure, and end-to-end encrypted storage solution
+
+Building
+--------
+
+The build system uses `Nix`_ which must be installed before anything can be built.
+
+Documentation
+~~~~~~~~~~~~~
+
+The documentation can be built using this command::
+
+  nix-build docs.nix
+
+The documentation is also built on and published by CI.
+
+Testing
+-------
+
+The test system uses `Nix`_ which must be installed before any tests can be run.
+
+Unit tests are run using this command::
+
+  $ nix-build nixos/unit-tests.nix
+
+Unit tests are also run on CI.
+
+The system tests are run using this command::
+
+  $ nix-build nixos/system-tests.nix
+
+The system tests boot QEMU VMs which prevents them from running on CI at this time.
-- 
GitLab