summaryrefslogtreecommitdiff
path: root/doc.go
diff options
context:
space:
mode:
authorNick White <git@njw.name>2020-04-14 11:37:57 +0100
committerNick White <git@njw.name>2020-04-14 11:37:57 +0100
commit014af190c64b2fecbf5d69e9a13e45858e830e81 (patch)
treec8398b8b2b224f13309156b0554c7aa80bccfdc8 /doc.go
parent822ce40a7d708ed44d6e638e2e25db9261254d13 (diff)
Improve documentation throughout
Diffstat (limited to 'doc.go')
-rw-r--r--doc.go9
1 files changed, 9 insertions, 0 deletions
diff --git a/doc.go b/doc.go
new file mode 100644
index 0000000..0fffdd9
--- /dev/null
+++ b/doc.go
@@ -0,0 +1,9 @@
+// Copyright 2020 Nick White.
+// Use of this source code is governed by the GPLv3
+// license that can be found in the LICENSE file.
+
+// preproc contains various image processing methods which are useful
+// for preprocessing page images for OCR. It contains both library
+// functions to incorporate into your own projects and standalone
+// tools which can be used directly.
+package preproc