Skip to content

Commit cbfa61e

Browse files
committed
update readme
1 parent ee414a7 commit cbfa61e

File tree

1 file changed

+17
-14
lines changed

1 file changed

+17
-14
lines changed

README.md

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ additional functions. Tesseract Tools for Android is a set of Android APIs and
66
build files for the [Tesseract OCR](https://code.google.com/p/tesseract-ocr/) and [Leptonica](http://www.leptonica.com/) image processing libraries.
77

88
This project works with Tesseract v3.02. The required source code for Tesseract 3.02 and
9-
Leptonica 1.68 is included within the tess-two/jni folder.
9+
Leptonica 1.68 is included within the `tess-two/jni` folder.
1010

11-
The tess-two subdirectory contains tools for compiling the Tesseract and Leptonica
11+
The `tess-two` subdirectory contains tools for compiling the Tesseract and Leptonica
1212
libraries for use on the Android platform. It contains an Eclipse Android
1313
[library project](http://developer.android.com/guide/developing/projects/projects-eclipse.html#SettingUpLibraryProject)
1414
that provides a Java API for accessing natively-compiled Tesseract and Leptonica APIs.
@@ -28,12 +28,12 @@ results from Tesseract when calling GetRegions().
2828
## Requires
2929

3030
* Android 2.2 or higher
31-
* A trained data file for a language - available [here](https://code.google.com/p/tesseract-ocr/downloads/list). Data files must be extracted to a subdirectory named "tessdata".
31+
* A [trained data file](https://code.google.com/p/tesseract-ocr/downloads/list) for a language. Data files must be extracted to a subdirectory named `tessdata`.
3232

3333
eyes-two
3434
========
3535

36-
The eyes-two subdirectory contains a second, separate library project with additional image
36+
The `eyes-two` subdirectory contains a second, separate library project with additional image
3737
processing code copied from the [eyes-free project](http://code.google.com/p/eyes-free/) without
3838
modifications. It includes native functions for text detection, blurriness detection, optical flow
3939
detection, and thresholding. Building eyes-two is not necessary for using the Tesseract API.
@@ -44,32 +44,39 @@ convenience due to its dependency on Leptonica.
4444
Build
4545
=====
4646

47-
This project is set up to build on Android SDK Tools r19 and Android NDK r7c. The build works on 64-bit Ubuntu 11.04. It's been reported to not work on Ubuntu 11.10 (Issue 6).
47+
This project is set up to build on Android SDK Tools r19 and Android NDK r7c. The build works on Linux, Mac OS X, and Windows 7. See [Issues](https://github.com/rmtheis/tess-two/issues) for reported build issues.
4848

49-
On 64-bit Ubuntu, you may need to install the "ia32-libs" 32-bit compatibility library.
49+
On 64-bit Ubuntu, you may need to install the `ia32-libs` 32-bit compatibility library.
5050

5151
To build tess-two, run the following commands in the terminal:
5252

5353
git clone git://github.com/rmtheis/tess-two tess
54-
cd tess/tess-two
54+
cd tess
55+
cd tess-two
5556
ndk-build
5657
android update project --path .
5758
ant release
5859

5960
To build eyes-two, additionally run the following:
6061

61-
cd ../eyes-two
62+
cd ..
63+
cd eyes-two
6264
ndk-build
6365
android update project --path .
6466
ant release
6567

6668
After building, the tess-two and eyes-two projects can be imported into Eclipse using
6769
File->Import->Existing Projects into Workspace.
6870

71+
Maven
72+
=====
73+
74+
While this project does not require Maven (and this project has not yet been registered in a Maven central repository), it can be [integrated into a local Maven repository for convenience](http://www.jameselsey.co.uk/blogs/techblog/tesseract-ocr-on-android-is-easier-if-you-maven-ise-it-works-on-windows-too/).
75+
6976
License
7077
=======
7178

72-
This project is licensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html)
79+
This project is licensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html).
7380

7481
/*
7582
* Copyright 2011 Robert Theis
@@ -87,8 +94,4 @@ This project is licensed under the [Apache License, Version 2.0](http://www.apac
8794
* limitations under the License.
8895
*/
8996

90-
91-
This project contains third party software within "tess-two/jni" with separate license agreements:
92-
93-
* Tesseract 3.02 (Modified to add TessBaseAPI::GetCharacters())
94-
* Leptonica 1.68 (Unmodified)
97+
[Leptonica](http://www.leptonica.com) by Dan Bloomberg is licensed under a [Creative Commons Attribution 3.0 United States License](http://creativecommons.org/licenses/by/3.0/us/).

0 commit comments

Comments
 (0)