tesseract/INSTALL.GIT.md

# autotools (LINUX/UNIX , msys...)

If you have cloned Tesseract from GitHub, you must generate
the configure script.

If you have tesseract 4.0x installation in your system, please remove it
before new build.

You need Leptonica 1.74.2 (minimum) for Tesseract 4.0x.

Known dependencies for training tools (excluding leptonica):

 * compiler with c++11 support
 * automake
 * pkg-config
 * pango-devel
 * cairo-devel
 * icu-devel

So, the steps for making Tesseract are:

    $ ./autogen.sh
    $ ./configure
    $ make
    $ sudo make install
    $ sudo ldconfig
    $ make training
    $ sudo make training-install

You need to install at least English language and OSD traineddata files to
`TESSDATA_PREFIX` directory.

You can retrieve single file with tools like [wget](https://www.gnu.org/software/wget/), [curl](https://curl.haxx.se/), [GithubDownloader](https://github.com/intezer/GithubDownloader) or browser.

All language data files can be retrieved from git repository (useful only for packagers!).
(Repository is huge - more that 1.2 GB. You do NOT need to download traineddata files for
all languages).

    $ git clone https://github.com/tesseract-ocr/tessdata.git tesseract-ocr.tessdata


You need an Internet connection and [curl](https://curl.haxx.se/) to compile `ScrollView.jar`
because the build will automatically download
[piccolo2d-core-3.0.1.jar](https://search.maven.org/remotecontent?filepath=org/piccolo2d/piccolo2d-core/3.0.1/piccolo2d-core-3.0.1.jar) and
[piccolo2d-extras-3.0.1.jar](https://search.maven.org/remotecontent?filepath=org/piccolo2d/piccolo2d-extras/3.0.1/piccolo2d-extras-3.0.1.jar) and
[jaxb-api-2.3.1.jar](http://search.maven.org/remotecontent?filepath=javax/xml/bind/jaxb-api/2.3.1/jaxb-api-2.3.1.jar) and place them to `tesseract/java`.

Just run:

    $ make ScrollView.jar

and follow the instruction on [Viewer Debugging](https://tesseract-ocr.github.io/tessdoc/ViewerDebugging.html).


# CMAKE

There is alternative build system based on multiplatform [cmake](https://cmake.org/)

## LINUX

    $ mkdir build
    $ cd build && cmake .. && make
    $ sudo make install


## WINDOWS

See the [documentation](https://tesseract-ocr.github.io/tessdoc/) for more information on this.
improve cmake instruction and rename it to INSTALL.GIT.md 2015-10-11 23:09:01 +08:00			`# autotools (LINUX/UNIX , msys...)`

Small improvements for documentation Signed-off-by: Stefan Weil <sw@weilnetz.de> 2015-12-04 17:46:10 +08:00			`If you have cloned Tesseract from GitHub, you must generate`
improve cmake instruction and rename it to INSTALL.GIT.md 2015-10-11 23:09:01 +08:00			`the configure script.`

Update INSTALL.GIT.md add info about autoconf-archive 2016-12-27 01:03:07 +08:00			`If you have tesseract 4.0x installation in your system, please remove it`
improve cmake instruction and rename it to INSTALL.GIT.md 2015-10-11 23:09:01 +08:00			`before new build.`

Add additional information - minimum Leptonica version for 4.0x - sudo ldconfig 2017-09-12 14:02:27 +08:00			`You need Leptonica 1.74.2 (minimum) for Tesseract 4.0x.`

improve cmake instruction and rename it to INSTALL.GIT.md 2015-10-11 23:09:01 +08:00			`Known dependencies for training tools (excluding leptonica):`
Fix small code style issues (reported by Codacy) Signed-off-by: Stefan Weil <sw@weilnetz.de> 2024-06-10 12:58:42 +08:00
Update INSTALL.GIT.md add info about autoconf-archive 2016-12-27 01:03:07 +08:00			`* compiler with c++11 support`
Update documentation for installation Add two build dependencies which were missing and update the hints for building ScrollView.jar. Signed-off-by: Stefan Weil <sw@weilnetz.de> 2017-05-26 02:54:17 +08:00			`* automake`
			`* pkg-config`
improve cmake instruction and rename it to INSTALL.GIT.md 2015-10-11 23:09:01 +08:00			`* pango-devel`
			`* cairo-devel`
			`* icu-devel`

			`So, the steps for making Tesseract are:`

			`$ ./autogen.sh`
			`$ ./configure`
			`$ make`
			`$ sudo make install`
Add additional information - minimum Leptonica version for 4.0x - sudo ldconfig 2017-09-12 14:02:27 +08:00			`$ sudo ldconfig`
improve cmake instruction and rename it to INSTALL.GIT.md 2015-10-11 23:09:01 +08:00			`$ make training`
			`$ sudo make training-install`

Fix whitespace issues * Remove whitespace (blanks, tabs, cr) at line endings Signed-off-by: Stefan Weil <sw@weilnetz.de> 2017-09-17 00:47:04 +08:00			`You need to install at least English language and OSD traineddata files to`
			`TESSDATA_PREFIX` directory.
Add additional information - minimum Leptonica version for 4.0x - sudo ldconfig 2017-09-12 14:02:27 +08:00
			`You can retrieve single file with tools like [wget](https://www.gnu.org/software/wget/), [curl](https://curl.haxx.se/), [GithubDownloader](https://github.com/intezer/GithubDownloader) or browser.`
you do not need download all tessdata repository 2016-09-01 02:54:43 +08:00
Add additional information - minimum Leptonica version for 4.0x - sudo ldconfig 2017-09-12 14:02:27 +08:00			`All language data files can be retrieved from git repository (useful only for packagers!).`
			`(Repository is huge - more that 1.2 GB. You do NOT need to download traineddata files for`
Fix whitespace issues * Remove whitespace (blanks, tabs, cr) at line endings Signed-off-by: Stefan Weil <sw@weilnetz.de> 2017-09-17 00:47:04 +08:00			`all languages).`
Small improvements for documentation Signed-off-by: Stefan Weil <sw@weilnetz.de> 2015-12-04 17:46:10 +08:00
improve cmake instruction and rename it to INSTALL.GIT.md 2015-10-11 23:09:01 +08:00			`$ git clone https://github.com/tesseract-ocr/tessdata.git tesseract-ocr.tessdata`
Small improvements for documentation Signed-off-by: Stefan Weil <sw@weilnetz.de> 2015-12-04 17:46:10 +08:00
improve cmake instruction and rename it to INSTALL.GIT.md 2015-10-11 23:09:01 +08:00
adapt info about ScrollView.jar build 2018-10-12 23:56:33 +08:00			You need an Internet connection and [curl](https://curl.haxx.se/) to compile `ScrollView.jar`
			`because the build will automatically download`
Update piccolo2d-core and piccolo2d-extras Make also curl less noisy. Signed-off-by: Stefan Weil <sw@weilnetz.de> 2020-01-16 22:27:41 +08:00			`[piccolo2d-core-3.0.1.jar](https://search.maven.org/remotecontent?filepath=org/piccolo2d/piccolo2d-core/3.0.1/piccolo2d-core-3.0.1.jar) and`
			`[piccolo2d-extras-3.0.1.jar](https://search.maven.org/remotecontent?filepath=org/piccolo2d/piccolo2d-extras/3.0.1/piccolo2d-extras-3.0.1.jar) and`
adapt info about ScrollView.jar build 2018-10-12 23:56:33 +08:00			[jaxb-api-2.3.1.jar](http://search.maven.org/remotecontent?filepath=javax/xml/bind/jaxb-api/2.3.1/jaxb-api-2.3.1.jar) and place them to `tesseract/java`.
improve cmake instruction and rename it to INSTALL.GIT.md 2015-10-11 23:09:01 +08:00
Update documentation for installation Add two build dependencies which were missing and update the hints for building ScrollView.jar. Signed-off-by: Stefan Weil <sw@weilnetz.de> 2017-05-26 02:54:17 +08:00			`Just run:`
Small improvements for documentation Signed-off-by: Stefan Weil <sw@weilnetz.de> 2015-12-04 17:46:10 +08:00
improve cmake instruction and rename it to INSTALL.GIT.md 2015-10-11 23:09:01 +08:00			`$ make ScrollView.jar`

Replace references to the old wiki by new URLs Signed-off-by: Stefan Weil <sw@weilnetz.de> 2020-02-03 18:37:41 +08:00			`and follow the instruction on [Viewer Debugging](https://tesseract-ocr.github.io/tessdoc/ViewerDebugging.html).`
improve cmake instruction and rename it to INSTALL.GIT.md 2015-10-11 23:09:01 +08:00

			`# CMAKE`

			`There is alternative build system based on multiplatform [cmake](https://cmake.org/)`

			`## LINUX`

			`$ mkdir build`
			`$ cd build && cmake .. && make`
			`$ sudo make install`


			`## WINDOWS`

Replace references to the old wiki by new URLs Signed-off-by: Stefan Weil <sw@weilnetz.de> 2020-02-03 18:37:41 +08:00			`See the [documentation](https://tesseract-ocr.github.io/tessdoc/) for more information on this.`