Tesseract Open Source OCR Engine (main repository)
Clone or download
zdenop Merge pull request #1997 from noahmetzger/master
Renamed GetGlyphConfidences() to GetChoices() and glyph_confidences t…
Latest commit 9c2d1aa Oct 18, 2018
Permalink
Failed to load latest commit information.
.github Fix whitespace issues Aug 1, 2018
abseil @ e821380 Add Abseil as a submodule (needed for some of the new unit tests) Oct 11, 2018
android Update build rules for Android May 20, 2018
cmake Remove tests for function getline Jul 19, 2018
doc build doc only for tesseract engine Oct 12, 2018
googletest @ 2fe3bd9 Update googletest submodule to release v1.8.1 Oct 8, 2018
java fix building of ScrollView.jar with modern java version; fixes #1289 Oct 10, 2018
langtests add langtests for Devanagari and Sanskrit Sep 4, 2018
m4 Remove autoconf-archive dependency Jun 30, 2018
snap Add newline at end of file Sep 3, 2018
src Renamed GetGlyphConfidences() to GetChoices() and glyph_confidences t… Oct 17, 2018
tessdata Don't set page segmentation mode for unlv config Oct 4, 2018
test @ 0fc1844 Update test submodule Oct 11, 2018
tests googletest: Add dummy test Jul 24, 2017
unittest Fix uninitialized scalar variable (CID 1395880) Oct 16, 2018
unlvtests Fix whitespace issues Aug 1, 2018
.clang-format Update rules for clang-format Jul 1, 2018
.gitignore Add git tracking ignore rules for snap packaging Sep 3, 2018
.gitmodules Add Abseil as a submodule (needed for some of the new unit tests) Oct 11, 2018
.travis.yml Disable travis os x builds as they do not work well on travis-side. Sep 9, 2017
AUTHORS Update AUTHORS May 8, 2018
CMakeLists.txt Do not build tests by default. Oct 13, 2018
CONTRIBUTING.md Fix whitespace issues Aug 1, 2018
COPYING Result of clang tidy on recent merge Nov 7, 2016
ChangeLog Fix whitespace issues Aug 1, 2018
Dockerfile Fix and improve Dockerfile May 18, 2017
INSTALL Fix file endings Apr 25, 2018
INSTALL.GIT.md adapt info about ScrollView.jar build Oct 12, 2018
LICENSE Added missing license headers Nov 18, 2016
Makefile.am update dist-hook Oct 12, 2018
README.md remove insight.io badge Oct 9, 2018
VERSION Release candidate 3 Oct 14, 2018
appveyor.yml Use env variable in AppVeyor configuration Oct 9, 2018
autogen.sh Fix whitespace issues Aug 1, 2018
configure.ac add "sudo ldconfig" to install instruction. fixes #1212 Sep 29, 2018
cppan.yml Fix cppan build. Oct 14, 2018
docker-compose.yml Dockerifying using travis build script Mar 18, 2016
tesseract.pc.cmake Require tesseract/ for API header files (fixes potential name conflicts) Jun 17, 2018
tesseract.pc.in improve tesseract.pc.in - fixes #241 Mar 4, 2016

README.md

Tesseract OCR

Build Status Build status
Coverity Scan Build Status Code Quality: Cpp Total Alerts
GitHub license Downloads

About

This package contains an OCR engine - libtesseract and a command line program - tesseract. Tesseract 4 adds a new neural net (LSTM) based OCR engine which is focused on line recognition, but also still supports the legacy Tesseract OCR engine of Tesseract 3 which works by recognizing character patterns. Compatibility with Tesseract 3 is enabled by using the Legacy OCR Engine mode (--oem 0). It also needs traineddata files which support the legacy engine, for example those from the tessdata repository.

The lead developer is Ray Smith. The maintainer is Zdenko Podobny. For a list of contributors see AUTHORS and GitHub's log of contributors.

Tesseract has unicode (UTF-8) support, and can recognize more than 100 languages "out of the box".

Tesseract supports various output formats: plain-text, hocr(html), pdf, tsv, invisible-text-only pdf.

You should note that in many cases, in order to get better OCR results, you'll need to improve the quality of the image you are giving Tesseract.

This project does not include a GUI application. If you need one, please see the 3rdParty wiki page.

Tesseract can be trained to recognize other languages. See Tesseract Training for more information.

Brief history

Tesseract was originally developed at Hewlett-Packard Laboratories Bristol and at Hewlett-Packard Co, Greeley Colorado between 1985 and 1994, with some more changes made in 1996 to port to Windows, and some C++izing in 1998. In 2005 Tesseract was open sourced by HP. Since 2006 it is developed by Google.

The latest stable version is 3.05.01, released on June 1, 2017. Latest source code for 3.05 is available from 3.05 branch on GitHub.

Source code for the new LSTM based 4.0 version is available from the master branch on GitHub. Please note this branch is under active development.

See Release Notes and Change Log for more details of the releases.

Installing Tesseract

You can either Install Tesseract via pre-built binary package or build it from source.

Supported Compilers are:

  • GCC 4.8 and above
  • Clang 3.4 and above
  • MSVC 2015, 2017

Other compilers might work, but are not officially supported.

Running Tesseract

Basic command line usage:

tesseract imagename outputbase [-l lang] [--oem ocrenginemode] [--psm pagesegmode] [configfiles...]

For more information about the various command line options use tesseract --help or man tesseract.

For developers

Developers can use libtesseract C or C++ API to build their own application. If you need bindings to libtesseract for other programming languages, please see the wrapper section on AddOns wiki page.

Documentation of Tesseract generated from source code by doxygen can be found on tesseract-ocr.github.io.

Support

Before you submit an issue, please review the guidelines for this repository.

For support, first read the Wiki, particularly the FAQ to see if your problem is addressed there. If not, search the Tesseract user forum, the Tesseract developer forum and past issues, and if you still can't find what you need, ask for support in the mailing-lists.

Mailing-lists:

Please report an issue only for a bug, not for asking questions.

License

The code in this repository is licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

NOTE: This software depends on other packages that may be licensed under different open source licenses.

Latest Version of README

For the latest online version of the README.md see:

https://github.com/tesseract-ocr/tesseract/blob/master/README.md