aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md37
1 files changed, 37 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..77c5f87
--- /dev/null
+++ b/README.md
@@ -0,0 +1,37 @@
+Simple image filters
+====================
+
+A collection of simple image processing utilities using basic convolution
+matrices.
+
+Prerequisites
+-------------
+
+Python 3.4 or higher is required.
+Additionally, [OpenCV]'s Python bindings are used for image manipulation.
+Please note that [NumPy] is also required as a transitive dependency.
+The versions below have been verified to work properly.
+
+| Software | Version |
+| ------------- | ------- |
+| Python | 3.5.1 |
+| numpy | 1.11.0 |
+| opencv-python | 3.1.0 |
+
+[NumPy]: http://www.numpy.org/
+[OpenCV]: http://opencv.org/
+
+Windows binaries of the required packages for CPython can be acquired at the
+usual place: http://www.lfd.uci.edu/~gohlke/pythonlibs/.
+Please note that OpenCV's Python bindings require [Visual C++ Redistributable
+for Visual Studio 2015] to be installed on Windows.
+
+[Visual C++ Redistributable for Visual Studio 2015]: https://www.microsoft.com/en-us/download/details.aspx?id=48145
+
+License
+-------
+
+Distributed under the MIT License.
+See [LICENSE.txt] for details.
+
+[LICENSE.txt]: LICENSE.txt