From a542e5918aac3a70d8a066963b370f84e6a639f3 Mon Sep 17 00:00:00 2001 From: Mahesh Babu <54440602+maheshmb13@users.noreply.github.com> Date: Sun, 6 Jun 2021 21:43:53 +0530 Subject: [PATCH 1/5] Update README.md --- README.md | 142 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 142 insertions(+) diff --git a/README.md b/README.md index e69de29..73b05ba 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,142 @@ +[![LinkedIn][linkedin-shield]][linkedin-url] + + + + +
+

+ + Logo + + +

S-Crop

+ +

+ Snipping tool with OCR feature built with Electron. +
+ Download the desktop application now » +
+
+ Report Bug + · + Request Feature +

+

+ + + + +
+ Table of Contents +
    +
  1. + About The Project + +
    2. +
  2. + Getting Started +
      +
    • Working with code
      • +
    • Installation & Usage
      • +
    +
    3. +
  3. Contact
    4. +
  4. Acknowledgements
    5. +
+
+ + + + +## About The Project + +[![Product Name Screen Shot][product-screenshot]](https://example.com) + +Tired of making a doc or taking notes?
+S-Crop all-in-one snipping tool with OCR feature. Easily invoke using keyboard shortcuts. Select and copy the desired area of the screen easily to your clipboard. Also, extract the text from the selected area. Everything is copied to your clipboard. Make docs in a hassle free process. + +Here's why: +* Handling images while making a doc is difficult. +* Each time you need to take a screenshot, insert it into the doc and crop the desired area. +* So, S-Crop simplifies the task by simply copying the desired area to your clipboard + +### Built With + +* [Electron](https://www.electronjs.org/) +* [JQuery](https://jcrop.com/) +* [NodeJs](https://nodejs.org/en/) + + + + +## Getting Started + +[Download the desktop setup from here >>](https://github.com/maheshmb13/S-Crop/releases/) + +### To use the code: + +* Install the node modules using yarn command + ```sh + yarn + ``` +* To initiate the development process + ```sh + yarn start + ``` +* To distribute the application using electron-build + ```sh + yarn add electron-prebuilt-compile@1.7.9 --dev + + yarn distribute + ``` + + +### Installation & Usage + +1. Download the desktop application setup [here](https://github.com/maheshmb13/S-Crop/releases/) +2. Change the directory. Do not use default C directory to install the application, as this may lead to permission issues. Use D:/ or E:/ directories. Create a folder named S-Crop in any one of directory. Give this path during installation. +3. Install the application and you are all set. +4. There are currently two features:

+ SNIP
+ Crop the desired area of the screen and copy it to the clipboard. +

+ OCR
+ Extract text from the desired area of the screen and copy it to the clipboard. +

+ • Select the desired rectangle. The result will be copied to the clipboard. +

+ Keyboard Shorcuts: + ```Keyboard shortcuts + SNIP: CTRL+ALT+I + OCR: CTRL+ALT+O + Close the current cropping window: Press Esc + ``` + + + +## Contact + +[Linkedin](https://linkedin.com/in/maheshmb13) - (https://linkedin.com/in/maheshmb13)
+ +Project Link: [https://github.com/maheshmb13/S-Crop](https://github.com/maheshmb13/S-Crop) + + + + +## Acknowledgements +* [JCrop](https://jcrop.com/) +* [Electron](https://www.electronjs.org/) +* [Nodejs](https://nodejs.org/en/) +* [Readme Template](https://github.com/othneildrew/Best-README-Template) + + + + + + + +[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555 +[linkedin-url]: https://linkedin.com/in/maheshmb13 +[product-screenshot]: images/screenshot.png From ad7d81ce95a88585b68979861ad0e64cca9eddcd Mon Sep 17 00:00:00 2001 From: Mahesh Babu <54440602+maheshmb13@users.noreply.github.com> Date: Sun, 6 Jun 2021 21:45:27 +0530 Subject: [PATCH 2/5] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 73b05ba..61a8e63 100644 --- a/README.md +++ b/README.md @@ -65,7 +65,7 @@ Here's why: ### Built With * [Electron](https://www.electronjs.org/) -* [JQuery](https://jcrop.com/) +* [JCrop](https://jcrop.com/) * [NodeJs](https://nodejs.org/en/) From 4ec4dfc144d6f1c978ad9c53befb5eb0ec25f7f6 Mon Sep 17 00:00:00 2001 From: Mahesh Babu <54440602+maheshmb13@users.noreply.github.com> Date: Sun, 6 Jun 2021 21:45:56 +0530 Subject: [PATCH 3/5] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 61a8e63..8702d6e 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@

S-Crop

- Snipping tool with OCR feature built with Electron. + Snipping tool with OCR feature - Built with Electron.
Download the desktop application now »
From 070ca3830d7e58646f5a287cf08438fe2a55067e Mon Sep 17 00:00:00 2001 From: Mahesh Babu <54440602+maheshmb13@users.noreply.github.com> Date: Sun, 6 Jun 2021 22:05:39 +0530 Subject: [PATCH 4/5] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 8702d6e..54a2c14 100644 --- a/README.md +++ b/README.md @@ -66,6 +66,7 @@ Here's why: * [Electron](https://www.electronjs.org/) * [JCrop](https://jcrop.com/) +* [Tesseract.js](https://tesseract.projectnaptha.com/) * [NodeJs](https://nodejs.org/en/) @@ -128,6 +129,7 @@ Project Link: [https://github.com/maheshmb13/S-Crop](https://github.com/maheshmb ## Acknowledgements * [JCrop](https://jcrop.com/) * [Electron](https://www.electronjs.org/) +* [Tesseract.js](https://tesseract.projectnaptha.com/) * [Nodejs](https://nodejs.org/en/) * [Readme Template](https://github.com/othneildrew/Best-README-Template) From 380adf132e3eda18cb69212c7ef3a406b57052f2 Mon Sep 17 00:00:00 2001 From: Mahesh Babu <54440602+maheshmb13@users.noreply.github.com> Date: Mon, 7 Jun 2021 01:41:11 +0530 Subject: [PATCH 5/5] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 54a2c14..1ea926b 100644 --- a/README.md +++ b/README.md @@ -68,6 +68,7 @@ Here's why: * [JCrop](https://jcrop.com/) * [Tesseract.js](https://tesseract.projectnaptha.com/) * [NodeJs](https://nodejs.org/en/) +* [Electron-Builder](https://www.electron.build/) @@ -131,6 +132,7 @@ Project Link: [https://github.com/maheshmb13/S-Crop](https://github.com/maheshmb * [Electron](https://www.electronjs.org/) * [Tesseract.js](https://tesseract.projectnaptha.com/) * [Nodejs](https://nodejs.org/en/) +* [Electron-Builder](https://www.electron.build/) * [Readme Template](https://github.com/othneildrew/Best-README-Template)