Skip to content

Commit 8c19a5b

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

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# WordCheckerJava
2-
Counts word occurrences in a text file. Results are saved in alphabetical order in a simple HTML file. The application opens a GUI window.
2+
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.
4+
* Quickly find misspelt words in large texts
5+
* Sneak into the context around some keywords.
36

47
## How it works
58
Numbers and bracketed numbers (often reference signs) are listed separately.
@@ -9,9 +12,9 @@ Unchecking symbols can be useful if a source text contains some mathematical exp
912
With regular expressions, simple filtering for data types similar to ISBN, date or time, URLs or e-mail addresses is done; these tokens are listed separately as well. As regular expressions can be fiddly, I focused on a simple and stable solution so this filtering may not always yield perfect results.
1013

1114
## Use cases
12-
* Find out which ISBNs, e-mail addresses or URLs occurred in a long e-mail or messenger thread.
13-
* Have all occurrences of a word or a name been spelt in the same manner
14-
* Does a text contain a specific search term, at which line number 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.
15+
* 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.
1518

1619
## Usage
1720
`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).

0 commit comments

Comments
 (0)