-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
update docs for code and installation.
- Loading branch information
1 parent
470f918
commit 4907cdd
Showing
1 changed file
with
10 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,24 +1,19 @@ | ||
# vMono | ||
|
||
A GUI app to convert images (esp. scanned ones) to black-and-white by controlling the image threshold. | ||
Uses ImageMagick through Wand API and Qt as GUI through PyQt5. | ||
A GUI app to convert images (esp. scanned ones) to black-and-white by controlling the image threshold. | ||
|
||
## Supported Platforms | ||
|
||
Currently, only **MacOS** is supported. But the app can be built from source on any system. | ||
|
||
## Installation | ||
## Code | ||
|
||
### For MacOS | ||
Uses [Pillow](https://python-pillow.org/) for image processing and [Qt](https://www.qt.io/) for GUI through [PyQt5](https://www.riverbankcomputing.com/software/pyqt/intro). | ||
|
||
#### Step 1: Installing ImageMagick | ||
## Supported Platforms | ||
|
||
The app depends on ImageMagick. So, first install ImagickMagick through `brew` or through any other methods listed [here](https://imagemagick.org/script/download.php). | ||
- Windows 7/8/10 (Not tested) | ||
- Ubuntu 16.04 (tested on 18.04) | ||
- MacOS 10.14 (tested on 10.15) | ||
|
||
``` | ||
brew install imagemagick | ||
``` | ||
The app can also be built from source on any system that supports Qt and Python. | ||
|
||
#### Step 1: Installing the App | ||
## Installation | ||
|
||
Download and install the app. | ||
Download the installer corresponding to your system from the [Releases](https://github.com/vipranarayan14/vmono/releases) page. |