Merge pull request #4263 from stweil/codacy

Fix code style issues which were reported by Codacy

Author: egorpugin

.github/ISSUE_TEMPLATE.md

@@ -7,16 +7,18 @@
 If you think you found a bug in Tesseract, please create an issue.
 
 Use the [user forum](https://groups.google.com/g/tesseract-ocr) instead of creating an issue if ...
+
 * You have problems using Tesseract and need some help.
 * You have problems installing the software.
 * You are not satisfied with the accuracy of the OCR, and want to ask how you can improve it. Note: You should first read the [ImproveQuality](https://tesseract-ocr.github.io/tessdoc/ImproveQuality.html) documentation.
 * You are trying to train Tesseract and you have a problem and/or want to ask a question about the training process. Note: You should first read the **official** guides [[1]](https://tesseract-ocr.github.io/tessdoc/) or [[2]](https://tesseract-ocr.github.io/tessdoc/tess5/TrainingTesseract-5.html) found in the project documentation.
 * 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.
 
@@ -39,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.
 

CONTRIBUTING.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.
@@ -9,22 +9,23 @@ 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
+
+* 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.
@@ -35,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`
@@ -46,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.