Skip to content

Commit 0ea0375

Browse files
authored
Update README.md
1 parent 6debb27 commit 0ea0375

File tree

1 file changed

+51
-1
lines changed

1 file changed

+51
-1
lines changed

README.md

Lines changed: 51 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,52 @@
11
# android-ocr
2-
Experimental optical character recognition app
2+
3+
An experimental app for Android that performs optical character recognition (OCR) on images captured using the device camera.
4+
5+
Runs the Tesseract OCR engine using [tess-two](https://github.com/rmtheis/tess-two), a fork of Tesseract Tools for Android.
6+
7+
Most of the code making up the core structure of this project has been adapted from the ZXing Barcode Scanner. Along with Tesseract-OCR and Tesseract Tools for Android (tesseract-android-tools), several open source projects have been used in this project, including leptonica, google-api-translate-java, microsoft-translator-java-api, and jtar.
8+
9+
## Video
10+
11+
[![Video](http://img.youtube.com/vi/FOSgiPjGwx4/0.jpg)](http://www.youtube.com/watch?v=FOSgiPjGwx4)
12+
13+
A slightly modified version:
14+
15+
[![Video](http://img.youtube.com/vi/7vNepTmBTG8/0.jpg)](http://www.youtube.com/watch?v=7vNepTmBTG8)
16+
17+
## Requires
18+
19+
* A Windows Azure Marketplace Client ID and Client Secret (for translation) - [Documentation](http://msdn.microsoft.com/en-us/library/hh454950.aspx)
20+
* A Google Translate API key (for translation) - [Documentation](https://code.google.com/apis/console/?api=translate)
21+
22+
## Training data for OCR
23+
24+
A data file is required for every language you want to recognize. For English, this data file is included in the application assets and is automatically installed when the app is first run.
25+
26+
For other languages (Spanish, French, Chinese, etc.), the app will try to download the training data from an old Google Code repository that is no longer available, and [the download fails](https://github.com/rmtheis/android-ocr/issues/55). So if you want to use training data for other languages, you'll need to package the appropriate [training data files](https://github.com/tesseract-ocr/tessdata/tree/3.04.00) in the app or change the code to point to your own download location.
27+
28+
## Installation
29+
30+
To build and run the app, clone this project, open it as an existing project in Android Studio, and click Run.
31+
32+
## License
33+
34+
This project is licensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html)
35+
36+
/*
37+
* Copyright 2011 Robert Theis
38+
*
39+
* Licensed under the Apache License, Version 2.0 (the "License");
40+
* you may not use this file except in compliance with the License.
41+
* You may obtain a copy of the License at
42+
*
43+
* http://www.apache.org/licenses/LICENSE-2.0
44+
*
45+
* Unless required by applicable law or agreed to in writing, software
46+
* distributed under the License is distributed on an "AS IS" BASIS,
47+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
48+
* See the License for the specific language governing permissions and
49+
* limitations under the License.
50+
*/
51+
52+
One of the jar files in the android/libs directory (google-api-translate-java-0.98-mod2.jar) is licensed under the [GNU Lesser GPL](http://www.gnu.org/licenses/lgpl.html).

0 commit comments

Comments
 (0)