Skip to content

Commit 80bb865

Browse files
ShreeShree
authored andcommitted
Symlink Installation.md, reorder entries in README - WIP
1 parent 514a070 commit 80bb865

File tree

2 files changed

+46
-60
lines changed

2 files changed

+46
-60
lines changed

Installation.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Home.md

README.md

Lines changed: 45 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -1,94 +1,79 @@
11
# Tesseract User Manual
22

3-
## Tesseract
3+
## Introduction
44

55
Tesseract is an open source [text recognition (OCR)](https://en.wikipedia.org/wiki/Optical_character_recognition) Engine, available under the [Apache 2.0 license.](http://www.apache.org/licenses/LICENSE-2.0). The current official release is [4.1.1](https://github.com/tesseract-ocr/tesseract/releases/tag/4.1.1). The [master branch on Github](https://github.com/tesseract-ocr/tesseract.git) can be used by those who want the latest 5.0.0.Alpha code for LSTM (--oem 1) and legacy (--oem 0) Tesseract. The [3.05 branch on GitHub](https://github.com/tesseract-ocr/tesseract/tree/3.05) can be used by those who want the bug fixes for [3.05.02](https://github.com/tesseract-ocr/tesseract/releases/tag/3.05.02) release for legacy Tesseract.
66

7-
Tesseract can be used directly via command line, or (for programmers) using an [API](https://github.com/tesseract-ocr/tesseract/blob/master/include/tesseract/baseapi.h) to extract printed text from images. It supports a wide variety of languages. Tesseract doesn't have a built-in GUI, but there are several available from the [3rdParty](User-Projects-%E2%80%93-3rdParty.md) page.
7+
Tesseract can be used directly via command line, or (for programmers) using an [API](https://github.com/tesseract-ocr/tesseract/blob/master/include/tesseract/baseapi.h) to extract printed text from images. It supports a wide variety of languages. Tesseract doesn't have a built-in GUI, but there are several available from the [3rdParty](User-Projects--3rdParty.md) page.
88

9-
Tesseract can be used in your own project, under the terms of the [Apache License 2.0.](http://www.apache.org/licenses/LICENSE-2.0) It has a fully featured API, and can be compiled for a variety of targets including Android and the iPhone. See the [3rdParty](User-Projects-%E2%80%93-3rdParty) page for a sample of what has been done with it.
9+
Tesseract can be used in your own project, under the terms of the [Apache License 2.0.](http://www.apache.org/licenses/LICENSE-2.0) It has a fully featured API, and can be compiled for a variety of targets including Android and the iPhone. See the [3rdParty](User-Projects--3rdParty.md) page for a sample of what has been done with it.
1010

1111
If you have a question, first read the [documentation](https://tesseract-ocr.github.io/), particularly the [FAQ](FAQ.md) to see if your problem is addressed there. If not, search the [Tesseract user forum](http://groups.google.com/group/tesseract-ocr) or the
1212
[Tesseract developer forum](http://groups.google.com/group/tesseract-dev), and if you still can't find what you need, please ask us there.
1313

1414
Also, it is free software, so if you want to pitch in and help, please do!
15-
If you find a bug and fix it yourself, the best thing to do is to attach the patch to your bug report in the [Issues List](https://github.com/tesseract-ocr/tesseract/issues)
15+
If you find a bug and fix it yourself, the best thing to do is to attach the patch to your bug report in the [Issues List](https://github.com/tesseract-ocr/tesseract/issues).
1616

17-
### Documentation
17+
This user manual is for Tesseract versions 4.x.x and 5.0.0.Alpha. For versions 3.05.02 and older, see the [documentation for old versions](OldVersionDocs.md).
1818

19-
- [Documentation](Documentation.md)
20-
- [Downloads](Downloads.md)
21-
- [FAQ-Old](FAQ-Old.md)
22-
- [Planning](Planning.md)
23-
- [ReleaseNotes](ReleaseNotes.md)
24-
- [Technical-Documentation](Technical-Documentation.md)
25-
- [TesseractOpenCL](TesseractOpenCL.md)
19+
### Releases and Changelog
2620

27-
### Build/Installation Instructions
21+
- [Release Planning](Planning.md)
22+
- [Downloads](Downloads.md)
23+
- [Releases](https://github.com/tesseract-ocr/tesseract/releases)
24+
- [Release Notes](ReleaseNotes.md)
25+
- [API/ABI changes review for Tesseract](https://abi-laboratory.pro/?view=timeline&l=tesseract)
26+
- [Changelog](https://github.com/tesseract-ocr/tesseract/blob/master/ChangeLog)
27+
- [4.0x-Changelog](4.0x-Changelog.md)
2828

29+
### Compiling and Installation
2930
- [Compiling-–-GitInstallation](Compiling-–-GitInstallation.md)
3031
- [Compiling](Compiling.md)
31-
- [Installation](Home.md)
32-
33-
### Usage
32+
- [Installation](Installation.md)
33+
- [4.0-Docker-Containers](4.0-Docker-Containers.md)
3434

35-
- [Command-Line-Usage](Command-Line-Usage.md)
35+
### Language Traineddata Files
36+
- [Data-Files-Contributions](Data-Files-Contributions.md)
3637
- [Data-Files-in-different-versions](Data-Files-in-different-versions.md)
38+
- [Data-Files-in-tessdata_fast](Data-Files-in-tessdata_fast.md)
39+
- [Data-Files](Data-Files.md)
40+
41+
### Usage
3742
- [ImproveQuality](ImproveQuality.md)
43+
- [APIExample-user_patterns](APIExample-user_patterns.md)
44+
- [APIExample](APIExample.md)
45+
- [Command-Line-Usage](Command-Line-Usage.md)
46+
- [User-App-Example](User-App-Example.md)
47+
- [ViewerDebugging](ViewerDebugging.md)
48+
- [4.0x-Common-Errors-and-Resolutions](4.0x-Common-Errors-and-Resolutions.md)
49+
- [Frequently Asked Qustions](FAQ.md)
3850

3951
### Testing
40-
4152
- [TestingTesseract](TestingTesseract.md)
4253
- [UNLV-Testing-of-Tesseract](UNLV-Testing-of-Tesseract.md)
4354

44-
### Training
55+
### Technical Information
56+
- [TesseractOpenCL](TesseractOpenCL.md)
57+
- [NeuralNetsInTesseract4.00](NeuralNetsInTesseract4.00.md)
58+
- [VGSLSpecs](VGSLSpecs.md)### Technical Information
4559

60+
### Training
61+
- [4.0-Accuracy-and-Performance](4.0-Accuracy-and-Performance.md)
62+
- [4.0-with-LSTM](4.0-with-LSTM.md)
63+
- [Documentation](Documentation.md)
64+
- [Fonts](Fonts.md)
65+
- [LSTM Training from Images and Groundtruth Transcription](https://github.com/tesseract-ocr/tesstrain)
66+
- [Making-Box-Files---4.0](Making-Box-Files---4.0.md)
67+
- [Technical-Documentation](Technical-Documentation.md)
68+
- [The-Hallucination-Effect](The-Hallucination-Effect.md)
4669
- [Training-Tesseract](Training-Tesseract.md)
47-
- [ViewerDebugging](ViewerDebugging.md)
48-
49-
### Examples
50-
51-
- [APIExample-user_patterns](APIExample-user_patterns.md)
52-
- [APIExample](APIExample.md)
53-
- [User-App-Example](User-App-Example.md)
70+
- [TrainingTesseract-4.00---Finetune](TrainingTesseract-4.00---Finetune.md)
71+
- [TrainingTesseract-4.00](TrainingTesseract-4.00.md)
5472

5573
### External Projects
56-
5774
- [AddOns](AddOns.md)
5875
- [User-Projects-–-3rdParty](User-Projects-–-3rdParty.md)
5976

60-
## Tesseract 5 Alpha (git master branch)
61-
62-
- [LSTM Training from Images and Groundtruth Transcription](https://github.com/tesseract-ocr/tesstrain)
63-
64-
## Tesseract 4
65-
66-
- [4.0-with-LSTM](4.0-with-LSTM.md)
67-
- [NeuralNetsInTesseract4.00](NeuralNetsInTesseract4.00.md)
68-
- [VGSLSpecs](VGSLSpecs.md)
69-
- [4.0x-Changelog](4.0x-Changelog.md)
70-
- [4.0-Accuracy-and-Performance](4.0-Accuracy-and-Performance.md)
71-
72-
### Tesseract 4 Build/Installation
73-
74-
- [4.0-Docker-Containers](4.0-Docker-Containers.md)
75-
- [Home](Home.md)
76-
77-
### Tesseract 4 Traineddata Files
78-
79-
- [Data-Files](Data-Files.md)
80-
- [Data-Files-in-tessdata_fast](Data-Files-in-tessdata_fast.md)
81-
- [Data-Files-Contributions](Data-Files-Contributions.md)
82-
83-
### Tesseract 4 LSTM Training
84-
85-
- [TrainingTesseract-4.00](TrainingTesseract-4.00.md)
86-
- [TrainingTesseract-4.00---Finetune](TrainingTesseract-4.00---Finetune.md)
87-
- [4.0x-Common-Errors-and-Resolutions](4.0x-Common-Errors-and-Resolutions.md)
88-
- [Fonts](Fonts.md)
89-
- [Making-Box-Files---4.0](Making-Box-Files---4.0.md)
90-
- [The-Hallucination-Effect](The-Hallucination-Effect.md)
91-
92-
### Old Versions
77+
### User Manual for Old Versions
9378

9479
- [Tesseract 3 Documentation](OldVersionDocs.md)

0 commit comments

Comments
 (0)