diff --git a/README.rst b/README.rst new file mode 100644 index 0000000000000000000000000000000000000000..5034d29f31015b1acbb13f1358b4cf2f9f305f22 --- /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 `_, either version 3 of the License, or (at your option) any later version.