diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 56bb0d72..3a0f7e28 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -15,9 +15,10 @@ Use the [user forum](https://groups.google.com/g/tesseract-ocr) instead of creat * You have a general question. An issue should only be reported if the platform you are using is one of these: - * Linux (but not a version that is more than 4 years old) - * Windows (Windows 7 or newer version) - * macOS (last 3 releases) + +* Linux (but not a version that is more than 4 years old) +* Windows (Windows 7 or newer version) +* macOS (last 3 releases) For older versions or other operating systems, use the Tesseract forum. @@ -40,8 +41,9 @@ Post example files to demonstrate the problem. BUT don't post files with private info (about yourself or others). When attaching a file to the issue report / forum ... - * Do not post a file larger than 20 MB. - * GitHub supports only few file name extensions like `.png` or `.txt`. If GitHub rejects your files, you can compress them using a program that can produce a zip archive and then load this zip file to GitHub. + +* Do not post a file larger than 20 MB. +* GitHub supports only few file name extensions like `.png` or `.txt`. If GitHub rejects your files, you can compress them using a program that can produce a zip archive and then load this zip file to GitHub. Do not attach programs or libraries to your issues/posts. diff --git a/INSTALL.GIT.md b/INSTALL.GIT.md index 22a2be46..a9cc3007 100644 --- a/INSTALL.GIT.md +++ b/INSTALL.GIT.md @@ -1,4 +1,4 @@ -# autotools (LINUX/UNIX , msys...) +## autotools (LINUX/UNIX , msys...) If you have cloned Tesseract from GitHub, you must generate the configure script. @@ -10,22 +10,22 @@ 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 +* 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 + ./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. @@ -36,7 +36,7 @@ All language data files can be retrieved from git repository (useful only for pa (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 + 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` @@ -47,22 +47,22 @@ because the build will automatically download Just run: - $ make ScrollView.jar + make ScrollView.jar and follow the instruction on [Viewer Debugging](https://tesseract-ocr.github.io/tessdoc/ViewerDebugging.html). -# CMAKE +## cmake There is alternative build system based on multiplatform [cmake](https://cmake.org/) -## LINUX +### LINUX - $ mkdir build - $ cd build && cmake .. && make - $ sudo make install + mkdir build + cd build && cmake .. && make + sudo make install -## WINDOWS +### WINDOWS See the [documentation](https://tesseract-ocr.github.io/tessdoc/) for more information on this.