Skip to content

Latest commit

 

History

History
84 lines (53 loc) · 2.46 KB

README.md

File metadata and controls

84 lines (53 loc) · 2.46 KB
Raw

Binocles

The software’s purpose is to facilitate the beta reading of texts by their users. It allows the user to:

  • define and manage their own commenting nomenclature with different comment styles.
  • manage the texts in different books containing chapters, each text being one chapter.
  • comment the texts with comments of different types with visual feedback and indicators on the text in review.
  • save their current work to re-open it at a later date.
  • export/import current or previous work.
  • render their reviews in different formats so it can be displayed or shared easily on different platforms.

Dependencies

Only Java 21 JDK is required for runtime.

This software is developed with Gradle as dependency manager.

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

Testing dependencies:

The project is a gradle multi-project with the following sub-projects:

  • model model of the application
    • uses utils as dependency
  • ui everything regarding the ui
    • uses model and utils as dependency
  • utils utils unrelated to business logic

Installation

Just download the latest JAR.

Executing the software

The project is still in development, there are no executable yet.

gradle run

In order to open a file when starting the software with gradle:

gradle run --args='<path-to-file>'

Compilation

./gradlew compileJava

Unit tests

./gradlew test

Help

Check out the wiki on Github.

Report issues

Please report any found issues to issues 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