Skip to content

Books analyzer, which allows to find the most frequently used English words in the text and add them to https://lingualeo.com dictionary.

License

Notifications You must be signed in to change notification settings

ilyavy/lingualeo-book-reading-assistant

Repository files navigation

English Book Reading Assistant

ilyavy Coverage Maintainability Rating Reliability Rating Security Rating

The GUI desktop application, allows to analyze English books and add the most frequently used in the text words into https://lingualeo.com dictionary for further learning.

It is supposed that it will help to learn the most frequently used words before reading the book, to make reading experience more smooth and enjoyable.

Supported book formats:

  • plain text (.txt).

Usage

The application is distributed via a jar-file.

Running pre-built binary

It can be downloaded from the releases tab in the repository. And then launched from the directory, where it was downloaded, using the command (for the latest release):

java --enable-preview -jar lingualeo-book-reading-assistant-1.0.0.jar

The application will start in a new window.

Building from sources

In order to build the executable jar-file from the sources, it's needed to use the command:

mvn package

The application then can be run from target directory with the command:

java --enable-preview -jar lingualeo-book-reading-assistant.jar

Project's structure

├── src
    ├── main      # source-set of the application
    └── perf      # source-set of the performance benchmark
└── book-samples  # books samples