README: Initial commit.
This commit is contained in:
parent
3f9e67de3a
commit
f8ea5ce62c
1 changed files with 23 additions and 0 deletions
23
README.rst
Normal file
23
README.rst
Normal 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.
|
Loading…
Reference in a new issue