summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorNick White <git@njw.name>2020-02-26 17:41:03 +0000
committerNick White <git@njw.name>2020-02-26 17:41:03 +0000
commit4462088b53fc303f9de5bb6bc2149d70684c3572 (patch)
tree0dbdead532e3289d0c9529273a8f876336c6901e /README
parent58d5b93cf895863ee7073b93adea8ee38f56d00e (diff)
Pretty up README
Diffstat (limited to 'README')
-rw-r--r--README8
1 files changed, 4 insertions, 4 deletions
diff --git a/README b/README
index 08c48bd..e457534 100644
--- a/README
+++ b/README
@@ -9,23 +9,23 @@ operations much faster.
This is a Go package, and can be installed in the standard go way,
by running `go get rescribe.xyz/integralimg` once go is installed.
-# Bugs
+## Bugs
The standard deviation and mean functions don't produce precisely
the same result as those run on non integral images. The difference
is small enough that it has little effect for most uses, but it
ought to be identical.
-# TODO
+## TODO
Write tests for the package.
-# Contributions
+## Contributions
Any and all comments, bug reports, patches or pull requests would
be very welcomely received. Please email them to <nick@rescribe.xyz>.
-# License
+## License
This package is licensed under the GPLv3. See the LICENSE file for
more details.