From d1199f308c24c17b9e038cac193d8d574b345fe5 Mon Sep 17 00:00:00 2001 From: Nick White Date: Wed, 26 Feb 2020 17:40:25 +0000 Subject: Pretty up README --- README | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) (limited to 'README') diff --git a/README b/README index 4a93b1e..5277d4e 100644 --- a/README +++ b/README @@ -5,7 +5,10 @@ useful for preprocessing page images for OCR. It also contains several commands in the cmd/ directory which can be used to preprocess images directly. -# Commands +This is a Go package, and can be installed in the standard go way, +by running `go get rescribe.xyz/preproc/...` once go is installed. + +## Commands There are several commands in the cmd/ directory which are useful in their own right as well as serving as examples of using the @@ -18,19 +21,19 @@ package. - wipe : wipes sections of an image that are outside an area detected as content -# Bugs +## Bugs The integral image operations don't produce exactly the same result as their non-integral image counterparts. The difference is small enough that it has little effect on the output images, but it ought to be identical. -# Contributions +## Contributions Any and all comments, bug reports, patches or pull requests would be very welcomely received. Please email them to . -# License +## License This package is licensed under the GPLv3. See the LICENSE file for more details. -- cgit v1.2.1-24-ge1ad