diff options
| author | Egor Tensin <Egor.Tensin@gmail.com> | 2016-08-30 01:57:00 +0300 |
|---|---|---|
| committer | Egor Tensin <Egor.Tensin@gmail.com> | 2016-08-30 01:57:00 +0300 |
| commit | 61f13a8708cfb0adadf31b3d1ffe5f70b1103e0f (patch) | |
| tree | 5386c793836e85801fd2c9116b83b191247c63b5 /README.md | |
| parent | factor common code out (diff) | |
| download | filters-61f13a8708cfb0adadf31b3d1ffe5f70b1103e0f.tar.gz filters-61f13a8708cfb0adadf31b3d1ffe5f70b1103e0f.zip | |
more useful help messages + README update
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 52 |
1 files changed, 42 insertions, 10 deletions
@@ -7,27 +7,59 @@ 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. +* Python 3.4 or higher +* [numpy] +* [opencv-python] + The versions below have been verified to work properly. | Software | Version | | ------------- | ------- | -| Python | 3.5.1 | +| CPython | 3.5.1 | | numpy | 1.11.0 | | opencv-python | 3.1.0 | -[NumPy]: http://www.numpy.org/ -[OpenCV]: http://opencv.org/ +[numpy]: http://www.numpy.org/ +[opencv-python]: http://opencv.org/ + +Windows binaries for CPython can be acquired at +http://www.lfd.uci.edu/~gohlke/pythonlibs/. -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. +OpenCV's Python bindings require [Visual C++ Redistributable for Visual Studio +2015] on Windows. [Visual C++ Redistributable for Visual Studio 2015]: https://www.microsoft.com/en-us/download/details.aspx?id=48145 +Usage +----- + +Run the scripts from the top-level directory using `python -m`. +Pass the `--help` flag to a script to examine its detailed usage information. + +For example (using Windows path format): + + > python -m bin.box_blur img\Lenna.png --radius 3 + +The complete list of usable scripts is given below. + +* box_blur.py — Apply box blur to an image. +* gaussian_blur.py — Apply Gaussian blur to an image. +* shift.py — Shift an image by a few pixels in a specified direction. + +Linting +------- + +Requires [PyLint]. +Run from the top-level directory: + + > pylint filters + ... + + > pylint bin + ... + +[PyLint]: https://www.pylint.org/ + License ------- |