Skip to content

Commit 333c3fc

Browse files
authored
Update README.md
1 parent 8c19a5b commit 333c3fc

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# WordCheckerJava
22
A Java UI which counts word occurrences in a text file. Results are sorted in alphabetical order and saved in a simple HTML file. With this, you can:
3-
* Search for multiple terms at once.
3+
* Search for multiple terms in one go.
44
* Quickly find misspelt words in large texts
55
* Sneak into the context around some keywords.
66

@@ -13,8 +13,10 @@ With regular expressions, simple filtering for data types similar to ISBN, date
1313

1414
## Use cases
1515
* Filter ISBNs, e-mail addresses or URLs that occur in a long e-mail or messenger thread.
16-
* Have all occurrences of a word or a name been spelt in the same manner?
17-
* Does a text contain a specific search term, and in which context, that is, within which sentence or paragraph, does the search term appear? The size of the text around that search term can be specified by the user.
16+
* Have all occurrences of a word or a name in a long thesis been spelt in the same manner?
17+
* Does a text contain a specific search term?<br>
18+
If so, in which context, that is, within which sentence or paragraph, does the search term appear?<br>
19+
The size of the shown text around that search term can be specified by the user.
1820

1921
## Usage
2022
`Open File`: browse to a text file. Set the topic (this will be the HTML title) and the target filename. The ending `.html` will be added automatically if missing. Target file will be placed in the same folder as the source text file (folder choice button may be implemented later).
@@ -31,3 +33,5 @@ This way, quick review of an entry by command line tools as well: such as
3133
## Requirements
3234
To compile, a JDK is required, it will run on a JRE 8 or later.<br>
3335
The jar file can then be used on different platforms including a Raspberry Pi (it has been tested on Raspberry Pi3).
36+
37+
![GUI-Beispiel](./examples/GUIWindowDE.png "German GUI window") ![GUI-Example](./examples/GUIWindowEN.png "Default GUI window") ![GUI-Example](./examples/GUIWarningFR.png "Example French GUI window")

0 commit comments

Comments
 (0)