Skip to content

Betareading software for reviewing long texts in an harmonised manner and importing/exporting the reviews in different formats..

License

Notifications You must be signed in to change notification settings

Sylordis/binocles

Repository files navigation

Binocles

The software’s purpose is to facilitate the beta reading of texts by their users, by allowing them to comment such texts with comments of different types, in a harmonised manner.

Dependencies

Only Java 20 is required for runtime.

This software is developed with Gradle as dependency manager.

It is using the following dependencies (already included as-is in the jar):

  • JavaFX
  • Apache Commons Text
  • Guava

Testing dependencies:

  • JUnit 5 (Jupiter)
  • Mockito
  • Hamcrest

Installation

Just download the latest JAR.

Executing the software

./gradlew run

Compilation

./gradlew compileJava

Unit tests

./gradlew test

Help

Check out the wiki on Github.

Author & Contributors

The only contributor and author is Sylvain "Sylordis" Domenjoud.

License

This project is distributed under the license GNU Affero General Public License v3.0.

Links

Project website: https://github.com/Sylordis/binocles

About

Betareading software for reviewing long texts in an harmonised manner and importing/exporting the reviews in different formats..

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published