Skip to content

Commit

Permalink
upedate README
Browse files Browse the repository at this point in the history
  • Loading branch information
gosha20777 committed Apr 3, 2018
1 parent c0990c1 commit cc3503b
Showing 1 changed file with 30 additions and 5 deletions.
35 changes: 30 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -13,18 +27,29 @@ 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
- SciPy
- 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

0 comments on commit cc3503b

Please sign in to comment.