README: Initial commit.

This commit is contained in:
Brett Smith 2020-03-18 16:21:06 -04:00
parent 3f9e67de3a
commit f8ea5ce62c

23
README.rst Normal file
View file

@ -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.