Skip to content

Commit

Permalink
Added readme content.
Browse files Browse the repository at this point in the history
  • Loading branch information
andrewlalis committed Mar 25, 2022
1 parent 74888e1 commit d727ff5
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,14 @@
# EmailIndexer
Utility for generating Lucene indexes for collections of emails.
Utility for generating Lucene indexed datasets for collections of emails, and provides a browser application for browsing and interacting with datasets.

## Setup
Simply download the latest available JAR file via the **Releases** section of this GitHub repository, and run it. The email dataset browser application will open to an empty interface.

**Note**: Java version 17 or higher is required to run this program.

To start analyzing some emails, you can either:
- Generate a new dataset
- Open an existing dataset, via `File > Open Dataset`. You may open datasets from directories, or from compressed ZIP files; in the latter case, the zip file will be unzipped to a directory.

## Generating a Dataset

0 comments on commit d727ff5

Please sign in to comment.