Skip to content

Commit 979b12e

Browse files
pvorbpvorb
committed
Merge branch 'release/0.1.0'
2 parents 2ab4fb0 + c91971f commit 979b12e

224 files changed

Lines changed: 8049 additions & 839 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.gitignore‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
1-
.classpath
2-
.gradle
3-
.project
4-
.settings
5-
bin
6-
build
1+
.idea/
2+
*.iml
3+
target/
4+
/gui/hs_err_pid*.log

‎README.md‎

Lines changed: 31 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
1-
# Tesseract GUI
1+
# tesseract4java: Tesseract GUI
22

33

4-
A graphical user interface for the [Tesseract OCR engine][tesseract]. The
5-
program has been introduced in the [Master’s thesis “Analyses and Heuristics for
6-
the Improvement of Optical Character Recognition Results for Fraktur
7-
Texts”][thesis] by Paul Vorbach.
4+
A graphical user interface for the [Tesseract OCR engine][tesseract]. The program has been introduced in the [Master’s
5+
thesis “Analyses and Heuristics for the Improvement of Optical Character Recognition Results for Fraktur Texts”][thesis]
6+
by Paul Vorbach.
87

9-
[tesseract]: https://code.google.com/p/tesseract-ocr/
8+
[tesseract]: https://github.com/tesseract-ocr/tesseract
109
[thesis]: http://nbn-resolving.de/urn/resolver.pl?urn:nbn:de:bvb:20-opus-106527
1110

1211

@@ -33,20 +32,38 @@ Evaluation view with a transcription field
3332
![Batch Export](https://raw.githubusercontent.com/tesseract4java/tesseract-gui/master/screenshots/gui-batch-export.png)
3433
Batch export functionality to handle large projects
3534

36-
## Download & Usage
35+
## Building and running the software
3736

38-
You can download and build the source code using Gradle. I will soon publish
39-
more detailed information on how to do this as well as a binary release.
37+
This software is written in Java and can be built using [Apache Maven]. In order to build the software you have to
38+
follow these steps:
4039

40+
1. Obtain a copy either by cloning the repository or downloading the current [zip file][zip].
41+
2. Also obtain a copy of a [patched version of ocrevalUAtion][ocrevalUAtion patched] ([zip file][ocrevalUAtion zip]).
42+
3. Open a command line in the ocrevalUAtion directory and run `mvn clean install`.
43+
4. `cd` to the tesseract4java directory and run `mvn clean package -Pstandalone`. This will include the
44+
Tesseract binaries for your platform. You can manually define the platform by providing the option
45+
`-Djavacpp.platform=[PLATFORM]` (available platforms are `windows-x86_64`, `windows-x86`, `linux-x86_64`, `linux-x86`,
46+
and `macosx-x86_64`).
47+
48+
After you've run through all steps, the directory "tesseract4java/gui/target" will contain the file
49+
"tesseract4java-[VERSION]-[PLATFORM].jar", which you can run by double-clicking or executing
50+
`java -jar tesseract4java-[VERSION]-[PLATFORM].jar`.
51+
52+
[Apache Maven]: https://maven.apache.org/
53+
[zip]: https://github.com/tesseract4java/tesseract4java/archive/develop.zip
54+
[ocrevalUAtion patched]: https://github.com/tesseract4java/ocrevalUAtion
55+
[ocrevalUAtion zip]: https://github.com/tesseract4java/ocrevalUAtion/archive/master.zip
4156

4257
## Credits
4358

44-
- This software uses the [Tesseract OCR engine][tesseract].
59+
- This software uses the [Tesseract OCR engine][tesseract] ([APLv2.0]).
4560
- This software uses [ocrevalUAtion] by Rafael C. Carrasco for providing
46-
accuracy measures of the OCR results.
61+
accuracy measures of the OCR results ([GPLv3]).
4762
- This software uses the [Silk icon set][silk] by Mark James
48-
([famfamfam.com]).
63+
([famfamfam.com]) ([CC-BY-3.0]).
4964

65+
[APLv2.0]: http://www.apache.org/licenses/LICENSE-2.0
66+
[GPLv3]: https://www.gnu.org/licenses/gpl-3.0.html
5067
[ocrevalUAtion]: https://github.com/impactcentre/ocrevalUAtion
5168
[silk]: http://www.famfamfam.com/lab/icons/silk/
5269
[famfamfam.com]: http://www.famfamfam.com/
@@ -58,8 +75,8 @@ more detailed information on how to do this as well as a binary release.
5875
GPLv3
5976

6077
~~~
61-
Tesseract GUI - a graphical user interface for the Tesseract OCR engine
62-
Copyright (C) 2014 Paul Vorbach
78+
tesseract4java - a graphical user interface for the Tesseract OCR engine
79+
Copyright (C) 2014-2016 Paul Vorbach
6380
6481
This program is free software: you can redistribute it and/or modify
6582
it under the terms of the GNU General Public License as published by

‎build-releases.sh‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
#!/bin/sh
2+
3+
mvn clean
4+
mvn test
5+
6+
mvn package -Pstandalone -Djavacpp.platform=windows-x86_64 -DskipTests
7+
mvn package -Pstandalone -Djavacpp.platform=windows-x86 -DskipTests
8+
mvn package -Pstandalone -Djavacpp.platform=linux-x86_64 -DskipTests
9+
mvn package -Pstandalone -Djavacpp.platform=linux-x86 -DskipTests
10+
mvn package -Pstandalone -Djavacpp.platform=macosx-x86_64 -DskipTests

‎build.gradle‎

Lines changed: 0 additions & 43 deletions
This file was deleted.

‎gui/pom.xml‎

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
<project xmlns="http://maven.apache.org/POM/4.0.0"
2+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
3+
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
4+
5+
<modelVersion>4.0.0</modelVersion>
6+
7+
<parent>
8+
<groupId>de.vorb</groupId>
9+
<artifactId>tesseract4java</artifactId>
10+
<version>0.1.0</version>
11+
</parent>
12+
13+
<artifactId>gui</artifactId>
14+
15+
<properties>
16+
<mainClass>de.vorb.tesseract.gui.controller.TesseractController</mainClass>
17+
</properties>
18+
19+
<dependencies>
20+
<dependency>
21+
<groupId>com.google.guava</groupId>
22+
<artifactId>guava</artifactId>
23+
<version>19.0</version>
24+
</dependency>
25+
<dependency>
26+
<groupId>de.vorb</groupId>
27+
<artifactId>tools</artifactId>
28+
<version>${project.version}</version>
29+
</dependency>
30+
<dependency>
31+
<groupId>com.twelvemonkeys.imageio</groupId>
32+
<artifactId>imageio-tiff</artifactId>
33+
<version>3.1.1</version>
34+
</dependency>
35+
<dependency>
36+
<groupId>junit</groupId>
37+
<artifactId>junit</artifactId>
38+
<version>4.12</version>
39+
<scope>test</scope>
40+
</dependency>
41+
</dependencies>
42+
43+
<build>
44+
<plugins>
45+
<plugin>
46+
<groupId>org.codehaus.mojo</groupId>
47+
<artifactId>exec-maven-plugin</artifactId>
48+
<version>1.5.0</version>
49+
<configuration>
50+
<mainClass>${mainClass}</mainClass>
51+
</configuration>
52+
</plugin>
53+
</plugins>
54+
</build>
55+
56+
<profiles>
57+
<profile>
58+
<id>standalone</id>
59+
<properties>
60+
<javacpp.platform>standalone</javacpp.platform>
61+
</properties>
62+
<build>
63+
<plugins>
64+
<plugin>
65+
<groupId>org.apache.maven.plugins</groupId>
66+
<artifactId>maven-assembly-plugin</artifactId>
67+
<version>2.6</version>
68+
<configuration>
69+
<finalName>${project.parent.name}-${project.version}-${javacpp.platform}</finalName>
70+
<descriptorRefs>
71+
<descriptorRef>jar-with-dependencies</descriptorRef>
72+
</descriptorRefs>
73+
<archive>
74+
<manifest>
75+
<addClasspath>true</addClasspath>
76+
<mainClass>${mainClass}</mainClass>
77+
</manifest>
78+
</archive>
79+
<appendAssemblyId>false</appendAssemblyId>
80+
</configuration>
81+
<executions>
82+
<execution>
83+
<id>assemble-all</id>
84+
<phase>package</phase>
85+
<goals>
86+
<goal>single</goal>
87+
</goals>
88+
</execution>
89+
</executions>
90+
</plugin>
91+
</plugins>
92+
</build>
93+
</profile>
94+
</profiles>
95+
</project>

0 commit comments

Comments
 (0)