Skip to content

Commit

Permalink
Enhanced README.md with a Table of Contents and Comprehensive Updates. (
Browse files Browse the repository at this point in the history 
#341)
  • Loading branch information
@zeuchie
zeuchie authored Feb 12, 2025
1 parent 8171a4a commit 05bcd7a
Showing 1 changed file with 56 additions and 52 deletions.
108 changes: 56 additions & 52 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,26 +1,36 @@
OpenNoteScanner
===============

## Table of Contents
- [Overview](#overview)
- [Features](#features)
- [Screenshots](#screenshots)
- [Requirements](#requirements)
- [How to Install](#how-to-install)
- [Usage](#usage)
- [Building from Source](#building-from-source)
- [Contributing](#contributing)
- [History](#history)
- [Roadmap](#roadmap)
- [Donations](#donations)
- [Acknowledgements](#acknowledgements)
- [License](#license)

Overview
-----
[![Build Status](https://travis-ci.org/ctodobom/OpenNoteScanner.svg)](https://travis-ci.org/ctodobom/OpenNoteScanner)

This little application provides a way on scanning handwritten notes and printed documents.

It automatically detect the edge of the paper over a contrastant surface.
OpenNoteScanner is an open-source application that provides a way to scan handwritten notes and printed documents using your mobile device.

When using the [printed special page template](https://github.com/ctodobom/OpenNoteScanner/raw/master/Page%20Templates/A4%20with%202%20pages.pdf) it automatically detects the QR Code printed on the bottom right corner and scans the page immediately.
### Features

After the page is detected, it compensates any perspective from the image adjusting it to a 90 degree top view and saves it on a folder on the device.
* Automatic edge detection of documents on contrasting surfaces.
* Perspective correction to a 90-degree top-down view.
* Support for a [printed special page template](https://github.com/ctodobom/OpenNoteScanner/raw/master/Page%20Templates/A4%20with%202%20pages.pdf) with a QR code for instant scanning.
* Ability to launch from other applications requesting images.
* Organize scanned documents in a local gallery.
* Export scans as a PDF or share as an image.

It is also possible to launch the application from any other application that asks for a picture, just make sure that there is no default application associated with this action.

Usage
-----

See the [FAQ](FAQ.md).


Screenshots
-----------
### Screenshots

[![screenshot1](http://i.imgur.com/1MDisD3m.jpg)](http://imgur.com/a/ypytF/embed#0)
[![screenshot1](http://i.imgur.com/ksvmOlym.png)](http://imgur.com/a/ypytF/embed#3)
Expand All @@ -30,33 +40,35 @@ Screenshots
Requirements
------------

Because of the version of OpenCV that is used in the project it needs to run on Android 5.0 (lollipop) or newer.
- Due to the version of OpenCV that is used, this project requires Android 5.0 (lollipop) or newer to run.

In order to capture and manipulate images Open Note Scanner depends on having the OpenCV Manager application installed. If not installed Open Note Scanner will ask to download it from https://github.com/ctodobom/OpenCV-3.1.0-Android or from Google Play Store.
- In order to capture and manipulate images, Open Note Scanner depends on having the OpenCV Manager application installed.
- If not installed, Open Note Scanner will ask to download it from https://github.com/ctodobom/OpenCV-3.1.0-Android or from the Google Play Store.


How to Install
--------------

Open Note Scanner is available for simplified installation on [Google Play Store](https://play.google.com/store/apps/details?id=com.todobom.opennotescanner), from [Amazon App Store](http://www.amazon.com/Claudemir-Todo-Bom-Open-Scanner/dp/B01EUAU924) and also from [F-Droid Android Open Source Repository](https://f-droid.org/repository/browse/?fdid=com.todobom.opennotescanner).
Open Note Scanner is available for simplified installation from [Google Play Store](https://play.google.com/store/apps/details?id=com.todobom.opennotescanner), from [Amazon App Store](http://www.amazon.com/Claudemir-Todo-Bom-Open-Scanner/dp/B01EUAU924) and also from [F-Droid Android Open Source Repository](https://f-droid.org/repository/browse/?fdid=com.todobom.opennotescanner).

[<img alt="Get it on Google Play" height="60" src="https://play.google.com/intl/en_us/badges/images/generic/en-play-badge.png" />](https://play.google.com/store/apps/details?id=com.todobom.opennotescanner&utm_source=global_co&utm_medium=prtnr&utm_content=Mar2515&utm_campaign=PartBadge&pcampaignid=MKT-Other-global-all-co-prtnr-py-PartBadge-Mar2515-1) [![Get it on F-Droid](https://f-droid.org/wiki/images/0/06/F-Droid-button_get-it-on.png)](https://f-droid.org/repository/browse/?fdid=com.todobom.opennotescanner)

**Disclaimer:** Google Play version is ad-supported.

Binary APK file is available [directly from GitHub in the releases section](https://github.com/ctodobom/OpenNoteScanner/releases) of the project.
Binary APK file is available directly from the [releases section](https://github.com/ctodobom/OpenNoteScanner/releases) on GitHub.

Instructions for building
Usage
-----
For detailed usage instructions, please refer to the [FAQ](FAQ.md).

Building from Source
-------------------------

### Android Studio

Import the project from GitHub using File -> New -> Project from Version Control -> GitHub, fill the URL https://github.com/ctodobom/OpenNoteScanner.git

It will ask for a base directory, normally AndroidStudioProjects, you can change it to your preference.

After this the Open Note Scanner can be built.

1. Import the project from GitHub using File -> New -> Project from Version Control -> GitHub, enter the URL https://github.com/ctodobom/OpenNoteScanner.git
2. Choose the base directory (usually AndroidStudioProjects, but you can change it to your preference).
3. Build the project.

### Command Line

Expand All @@ -76,23 +88,23 @@ $ export ANDROID_HOME=~/android-sdk-linux
$ ./gradlew assembleRelease
```

Instructions for Contributing
Contributing
-------------------------
If you're new to open-source, we recommend you to checkout our [_Contributing Guidelines_](https://github.com/ctodobom/OpenNoteScanner/blob/master/CONTRIBUTING.md) and [Setup Guidelines](https://github.com/ctodobom/OpenNoteScanner/blob/master/SETUP_GUIDELINES.md). Feel free to fork the project and send us a pull request.
Contributions are always welcome! If you're new to open-source, please check our [Contributing Guidelines](https://github.com/ctodobom/OpenNoteScanner/blob/master/CONTRIBUTING.md) and [Setup Guidelines](https://github.com/ctodobom/OpenNoteScanner/blob/master/SETUP_GUIDELINES.md). Feel free to fork the project and submit pull requests.

History
-------

I've started this app on a brazilian holyday "extended weekend" based on the fact that I was unable to find any open source application that does this job. I was mainly inspired on the RocketBook Wave closed source application.
I started this app while on a brazilian holiday (that is, an "extended weekend") based on the fact that I was unable to find any open source application that does this job. I was mainly inspired by the RocketBook Wave closed source application.

I really do not know if I will extend more the application, but I am writing bellow some objectives to make it better.
I really do not know if I will extend the application more, but I have written some objectives below on how to make it better.

Roadmap
-------

* enhance the image gallery of scanned documents
* register a share action in order to obtain documents already pictured through standard camera apps
* implement automatic action based on the RocketBook Wave marking of the page
* Enhance the image gallery of scanned documents.
* Register a share action in order to obtain documents already pictured through standard camera apps.
* Implement an automatic action based on the RocketBook Wave marking of the page.

Donations
---------
Expand All @@ -101,34 +113,28 @@ My job is on enterprise servers administration and some development consulting.

For being part of open source projects and documenting my work here I really do not charge anything. I am trying to avoid any type of ads also.

If you think that any information you obtained here is worth of some money and are willing to pay for it, feel free to send any amount through paypal or bitcoin.
If you think that any information you obtained here is worth of some money and are willing to pay for it, feel free to send any amount through PayPal or Bitcoin.

| Paypal | Bitcoin |
| ------ | ------- |
| [![](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=X6XHVCPMRQEL4) | <center> [![](http://api.qrserver.com/v1/create-qr-code/?color=000000&bgcolor=FFFFFF&data=bitcoin%3A1H5tqKZoWdqkR54PGe9w67EzBnLXHBFmt9&qzone=1&margin=0&size=200x200&ecc=L)](bitcoin:1H5tqKZoWdqkR54PGe9w67EzBnLXHBFmt9)<br />[1H5tqKZoWdqkR54PGe9w67EzBnLXHBFmt9](bitcoin:1H5tqKZoWdqkR54PGe9w67EzBnLXHBFmt9)</center> |

In order to fund the development of Open Note Scanner, since version 1.0.36 when downloaded from Google Play store the app will show ads on some screens and will also allow for donation through Google Play in-app purchase. There is no difference on the features available from Google Play version and F-Droid releases.


Contributing
------------

If you have any idea, feel free to fork it and submit your changes back to me.
In order to fund the development of Open Note Scanner, since version 1.0.36 when downloaded from Google Play Store the app will show ads on some screens and will also allow for donation through Google Play in-app purchase. There is no difference on the features available from Google Play version and F-Droid releases.

Thanks
Acknowledgements
------

### Contributors

As an open source application, contribution are always welcome.
As an open source application, contributions are always welcome.

Most translations contributions are listed on [CONTRIBUTORS.md file](https://github.com/ctodobom/OpenNoteScanner/blob/master/CONTRIBUTORS.md) and code contributors are listed on [the Changelog file](https://github.com/ctodobom/OpenNoteScanner/blob/master/CHANGELOG.md) and [the commits history](https://github.com/ctodobom/OpenNoteScanner/commits)
Most translation contributions are listed in the [CONTRIBUTORS.md](https://github.com/ctodobom/OpenNoteScanner/blob/master/CONTRIBUTORS.md) file and code contributors are listed on [the Changelog file](https://github.com/ctodobom/OpenNoteScanner/blob/master/CHANGELOG.md) and the [commits history](https://github.com/ctodobom/OpenNoteScanner/commits)

Other people helped submitting [Issue Reports](https://github.com/ctodobom/OpenNoteScanner/issues) and giving info through the [Telegram Group](https://t.me/OpenNoteScanner). Their help is appreciated as well.
We also thank those who have submitted [Issue Reports](https://github.com/ctodobom/OpenNoteScanner/issues) and provided feedback through the [Telegram Group](https://t.me/OpenNoteScanner).

### External code

This application wouldn't be possible without the great material produced by the community. I would like to give special thanks to the authors of essencial parts I've got on the internet and used in the code:
This application wouldn't be possible without the great material produced by the community. Special thanks to the authors of these essential components:

* [Android-er / GridView code sample](http://android-er.blogspot.com.br/2012/07/gridview-loading-photos-from-sd-card.html)
* [Android Hive / Full Screen Image pager](http://www.androidhive.info/2013/09/android-fullscreen-image-slider-with-swipe-and-pinch-zoom-gestures/)
Expand All @@ -141,9 +147,7 @@ License

Copyright 2016 - Claudemir Todo Bom

Software licensed under the GPL version 3 available in GPLv3.TXT and
online on http://www.gnu.org/licenses/gpl.txt.
This software is licensed under the GPL version 3, which can be found in the file GPLv3.TXT in this repository and
online at http://www.gnu.org/licenses/gpl.txt.

Use parts from other developers, sometimes with small changes,
references on autorship and specific licenses are on individual
source files.
Some parts of this software use code from other developers. References to the original authors and specific licenses can be found in the individual source files.

0 comments on commit 05bcd7a

Please sign in to comment.