This is the DAGsHub mirror of Tessaract OCR.

Tesseract Open Source OCR Engine
https://tesseract-ocr.github.io/

Stefan Weil 4a00b68c63 Fix lambda function for curl code errors 2 weeks ago
.github e1cf69fd9e [ci] Update. 2 weeks ago
abseil @ b832dce848 a350108592 Update submodule abseil to tagged release 20200225 3 weeks ago
cmake 674d6a90d8 Remove code for embedded build 9 months ago
doc 16553014e0 Replace references to the old wiki by new URLs 1 month ago
googletest @ 703bd9caab a7c9c566ee Update submodule googletest to tagged release release-1.10.0 3 weeks ago
include 6f2f310fdf Remove redundant method from class GenericVector 2 months ago
java 62010da593 Update piccolo2d-core and piccolo2d-extras 1 month ago
m4 6b250b5812 Remove autoconf-archive dependency 1 year ago
snap 31de2cf60e Add newline at end of file 1 year ago
src 4a00b68c63 Fix lambda function for curl code errors 2 weeks ago
tessdata df6b1ce452 remove legacy parameter disable_character_fragments from lstm.train 5 months ago
test @ e27d956691 e94392ef10 Update test submodule and fix pagesegmode_test 8 months ago
unittest 6f2f310fdf Remove redundant method from class GenericVector 2 months ago
.clang-format e262d71a56 Modifiy formatting rules 1 year ago
.gitignore 87841e9ace Remove more relicts from cppan build (fixes `make dist`) 3 months ago
.gitmodules 3318c9aadd Add Abseil as a submodule (needed for some of the new unit tests) 1 year ago
.lgtm.yml 57d0ae06c0 Use Python3 for LGTM 1 year ago
.travis.yml 92e543538a Update .travis.yml 5 months ago
AUTHORS cf132c0e79 Update AUTHORS 3 months ago
CMakeLists.txt 9df8710402 Merge branch 'master' of https://github.com/tesseract-ocr/tesseract 2 months ago
CONTRIBUTING.md 16553014e0 Replace references to the old wiki by new URLs 1 month ago
ChangeLog 16553014e0 Replace references to the old wiki by new URLs 1 month ago
Dockerfile ad30f52eed Dockerfile: Delete the apt-get lists after installing 1 year ago
INSTALL dabf3c299f Fix file endings 1 year ago
INSTALL.GIT.md 62010da593 Update piccolo2d-core and piccolo2d-extras 1 month ago
LICENSE 5913d7344f Added missing license headers 3 years ago
Makefile.am 87841e9ace Remove more relicts from cppan build (fixes `make dist`) 3 months ago
README.md 04a7650b51 Update README.md 2 weeks ago
VERSION bff6aaf302 Increase version number because of backward not compatible API code changes 11 months ago
appveyor.yml 8dc33b9815 [appveyor] Disable VS2019 image because it's too slow. 8 months ago
autogen.sh 6d32de484a Update autogen.sh 3 months ago
configure.ac 7f16162745 Fix previous commit 688f6490bb599950b742153bbae0d8c47eb04f83 3 months ago
docker-compose.yml 71ad8c9bff Dockerifying using travis build script 4 years ago
sw.cpp 916875d74a [sw] Fix mingw build. 2 weeks ago
tesseract.pc.cmake 41c3e93cb7 Add missing libraries in configuration for pkg-config 5 months ago
tesseract.pc.in 41c3e93cb7 Add missing libraries in configuration for pkg-config 5 months ago

README.md

Tesseract OCR

Build Status Build status Build status
Coverity Scan Build Status Total Alerts OSS-Fuzz
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, invisible-text-only PDF, TSV. The master branch also has experimental support for ALTO (XML) output.

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 documentation.

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 (LSTM based) stable version is 4.1.1, released on December 26, 2019. Latest source code is available from master branch on GitHub. Open issues can be found in issue tracker, and planning documentation.

The latest 3.0x version is 3.05.02, released on June 19, 2018. Latest source code for 3.05 is available from 3.05 branch on GitHub. There is no development for this version, but it can be used for special cases (e.g. see Regression of features from 3.0x).

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, 2019

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.

Examples can be found in the documentation.

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 in the AddOns documentation.

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 documentation, 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.

Tesseract uses Leptonica library which essentially uses a BSD 2-clause license.

Dependencies

Tesseract uses Leptonica library for opening input images (e.g. not documents like pdf). It is suggested to use leptonica with built-in support for zlib, png and tiff (for multipage tiff).

Latest Version of README

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

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