Skip to content

Commit 05bcd7a

Browse files
authored
Enhanced README.md with a Table of Contents and Comprehensive Updates. (#341)
1 parent 8171a4a commit 05bcd7a

File tree

1 file changed

+56
-52
lines changed

1 file changed

+56
-52
lines changed

README.md

Lines changed: 56 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,36 @@
11
OpenNoteScanner
22
===============
3-
3+
## Table of Contents
4+
- [Overview](#overview)
5+
- [Features](#features)
6+
- [Screenshots](#screenshots)
7+
- [Requirements](#requirements)
8+
- [How to Install](#how-to-install)
9+
- [Usage](#usage)
10+
- [Building from Source](#building-from-source)
11+
- [Contributing](#contributing)
12+
- [History](#history)
13+
- [Roadmap](#roadmap)
14+
- [Donations](#donations)
15+
- [Acknowledgements](#acknowledgements)
16+
- [License](#license)
17+
18+
Overview
19+
-----
420
[![Build Status](https://travis-ci.org/ctodobom/OpenNoteScanner.svg)](https://travis-ci.org/ctodobom/OpenNoteScanner)
521

6-
This little application provides a way on scanning handwritten notes and printed documents.
7-
8-
It automatically detect the edge of the paper over a contrastant surface.
22+
OpenNoteScanner is an open-source application that provides a way to scan handwritten notes and printed documents using your mobile device.
923

10-
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.
24+
### Features
1125

12-
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.
26+
* Automatic edge detection of documents on contrasting surfaces.
27+
* Perspective correction to a 90-degree top-down view.
28+
* 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.
29+
* Ability to launch from other applications requesting images.
30+
* Organize scanned documents in a local gallery.
31+
* Export scans as a PDF or share as an image.
1332

14-
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.
15-
16-
Usage
17-
-----
18-
19-
See the [FAQ](FAQ.md).
20-
21-
22-
Screenshots
23-
-----------
33+
### Screenshots
2434

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

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

35-
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.
45+
- In order to capture and manipulate images, Open Note Scanner depends on having the OpenCV Manager application installed.
46+
- 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.
3647

3748

3849
How to Install
3950
--------------
4051

41-
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).
52+
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).
4253

4354
[<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)
4455

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

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

49-
Instructions for building
60+
Usage
61+
-----
62+
For detailed usage instructions, please refer to the [FAQ](FAQ.md).
63+
64+
Building from Source
5065
-------------------------
5166

5267
### Android Studio
5368

54-
Import the project from GitHub using File -> New -> Project from Version Control -> GitHub, fill the URL https://github.com/ctodobom/OpenNoteScanner.git
55-
56-
It will ask for a base directory, normally AndroidStudioProjects, you can change it to your preference.
57-
58-
After this the Open Note Scanner can be built.
59-
69+
1. Import the project from GitHub using File -> New -> Project from Version Control -> GitHub, enter the URL https://github.com/ctodobom/OpenNoteScanner.git
70+
2. Choose the base directory (usually AndroidStudioProjects, but you can change it to your preference).
71+
3. Build the project.
6072

6173
### Command Line
6274

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

79-
Instructions for Contributing
91+
Contributing
8092
-------------------------
81-
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.
93+
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.
8294

8395
History
8496
-------
8597

86-
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.
98+
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.
8799

88-
I really do not know if I will extend more the application, but I am writing bellow some objectives to make it better.
100+
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.
89101

90102
Roadmap
91103
-------
92104

93-
* enhance the image gallery of scanned documents
94-
* register a share action in order to obtain documents already pictured through standard camera apps
95-
* implement automatic action based on the RocketBook Wave marking of the page
105+
* Enhance the image gallery of scanned documents.
106+
* Register a share action in order to obtain documents already pictured through standard camera apps.
107+
* Implement an automatic action based on the RocketBook Wave marking of the page.
96108

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

102114
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.
103115

104-
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.
116+
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.
105117

106118
| Paypal | Bitcoin |
107119
| ------ | ------- |
108120
| [![](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> |
109121

110-
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.
111-
112-
113-
Contributing
114-
------------
115-
116-
If you have any idea, feel free to fork it and submit your changes back to me.
122+
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.
117123

118-
Thanks
124+
Acknowledgements
119125
------
120126

121127
### Contributors
122128

123-
As an open source application, contribution are always welcome.
129+
As an open source application, contributions are always welcome.
124130

125-
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)
131+
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)
126132

127-
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.
133+
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).
128134

129135
### External code
130136

131-
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:
137+
This application wouldn't be possible without the great material produced by the community. Special thanks to the authors of these essential components:
132138

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

142148
Copyright 2016 - Claudemir Todo Bom
143149

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

147-
Use parts from other developers, sometimes with small changes,
148-
references on autorship and specific licenses are on individual
149-
source files.
153+
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 commit comments

Comments
 (0)