diff --git a/README.md b/README.md index cd9e725..6110b56 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,21 @@ NoteShrink ========== - -This script makes scans and handwritten notes more beautiful! The script clears synopses and scans from "dirt", improves their readability and reduces the size of the image. +This project makes scans and handwritten notes more beautiful! The program clears synopses and scans from "dirt", improves their readability and reduces the size of the image. + +## Tasks +- [X] Create an algoritm and console app +- [X] Create GUI +- [X] Add scan and print feature +- [ ] Add notes drawing and editing features + - [ ] Add a pen tool + - [ ] Add a text tool + - [ ] Add an eraser tool +- [ ] Add the ability to add more than one page +- [ ] Add the ability to save to PDF +- [ ] Add support for multi-thread processing +- [ ] Translate Python to C/C++ `(25%)` +- [ ] Maybe redraw GUI +- [ ] Create a web site with the same functionality ## Example @@ -13,7 +27,12 @@ This script makes scans and handwritten notes more beautiful! The script clears ![scan2](/examples/output2.png "Output image. 44.1 Kb") -## Requirements +## Building + +### Python +If you want to use the console version you may use only `Python` module. You can compile it to win32 `EXE` file with `cx_Freeze` ([How convert a .py to .exe](https://stackoverflow.com/questions/41570359/how-can-i-convert-a-py-to-exe-for-python) + +### Requirements for python - Python 3 - NumPy 1.10 or later @@ -21,10 +40,16 @@ This script makes scans and handwritten notes more beautiful! The script clears - ImageMagick - Image module Pillow -## Usage +### Usage ``` ./noteshrink.py IMAGE1 [IMAGE2 ...] ``` -Building the examples (already in `example_output`): +### CShrp + 1. Compile `Python` to `EXE` + 2. Build C# project + 3. Copy a Python `exe`, `dll` file and `lib` folder to `\bin\Debug\` or `\bin\Release\` directory (I'm sorry for this, but I promise I will fix it soon). + +### Requirements for CShrp + - Microsoft Visual C++ 2017 Redistributable Package