From f8ea5ce62c6ad47f08ad1ba32ff7bdcff8117cc5 Mon Sep 17 00:00:00 2001
From: Brett Smith <brettcsmith@brettcsmith.org>
Date: Wed, 18 Mar 2020 16:21:06 -0400
Subject: [PATCH] README: Initial commit.

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

diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..5034d29
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,23 @@
+Beancount plugin and tools for Conservancy's books
+==================================================
+
+Running tests
+-------------
+
+Run::
+
+  ./setup.py test
+
+Type checking
+-------------
+
+Most of the code is typed, except for very dynamic loader methods. To run the type checker::
+
+  ./setup.py typecheck
+
+This is expected to pass just like the unit tests.
+
+Legal
+-----
+
+Copyright © 2020  Brett Smith. Licensed under the `GNU Affero General Public License <https://www.gnu.org/licenses/agpl-3.0.html>`_, either version 3 of the License, or (at your option) any later version.